com.wewebu.ow.server.ao

Class OwSearchTemplatesManager

java.lang.Object

com.wewebu.ow.server.ao.OwSupportBasedManager

com.wewebu.ow.server.ao.OwSearchTemplatesManager

All Implemented Interfaces:

OwAOManager, OwConfigurableManager

public class OwSearchTemplatesManager
extends OwSupportBasedManager

Manager for OwSearchTemplate application objects.

Returns OwSearchTemplate objects.
Retrieves single objects and collection of objects.
Does not support parameterized retrieval through getApplicationObject(String, Object, boolean, boolean).

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Since:

3.2.0.0

Constructor Summary

Constructors

Constructor and Description
OwSearchTemplatesManager()
OwSearchTemplatesManager(OwAOSupport aoSupport_p, OwSearchTemplateFactory searchTemplateFactory_p) Constructor - an empty string base path will be used
OwSearchTemplatesManager(OwAOSupport aoSupport_p, String basePath_p, OwSearchTemplateFactory searchTemplateFactory_p, String singlePath_p, String multiplePath_p) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
OwSearchTemplate	getApplicationObject(String strName_p, boolean forceUserSpecificObject_p, boolean createIfNotExist_p) Returns the application object that is matched by the given name.
OwSearchTemplate	getApplicationObject(String strName_p, Object param_p, boolean forceUserSpecificObject_p, boolean createIfNotExist_p) Returns the application object that is matched by the given name.
List<OwSearchTemplate>	getApplicationObjects(String strName_p, boolean forceUserSpecificObject_p) Returns all application objects that are matched by the given name.
int	getManagedType()
OwAOType<?>	getType()
void	init(OwAOType<?> type, OwManagerConfiguration configuration, OwSupportsConfiguration supports, OwAOContext context)
protected OwSearchTemplateFactory	initSearchTemplateFactory(OwAOContext context)
String	toString()

Methods inherited from class com.wewebu.ow.server.ao.OwSupportBasedManager

getAOSupportObject, getAOSupportObjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OwSearchTemplatesManager

public OwSearchTemplatesManager()

OwSearchTemplatesManager

public OwSearchTemplatesManager(OwAOSupport aoSupport_p,
                        OwSearchTemplateFactory searchTemplateFactory_p)

Constructor - an empty string base path will be used

Parameters:

aoSupport_p - application OwObject persistence support

searchTemplateFactory_p - search template factory implementation

OwSearchTemplatesManager

public OwSearchTemplatesManager(OwAOSupport aoSupport_p,
                        String basePath_p,
                        OwSearchTemplateFactory searchTemplateFactory_p,
                        String singlePath_p,
                        String multiplePath_p)

Constructor

Parameters:

basePath_p - path relative to the persistence support root of the managed objects' container

aoSupport_p - application OwObject persistence support

searchTemplateFactory_p - search template factory implementation

singlePath_p - single objects relative path - influences only getApplicationObject(String, boolean, boolean) and getApplicationObject(String, Object, boolean, boolean)

multiplePath_p - multiple objects relative path - influences only getApplicationObjects(String, boolean)

Since:

3.2.0.0

Method Detail

getApplicationObject

public OwSearchTemplate getApplicationObject(String strName_p,
                                    Object param_p,
                                    boolean forceUserSpecificObject_p,
                                    boolean createIfNotExist_p)
                                      throws OwException

Description copied from interface: OwAOManager

Returns the application object that is matched by the given name.

Parameters:

strName_p - name of the object to retrieve e.g. "userprefs"

param_p - optional Object, can be null

forceUserSpecificObject_p - if true, the object must be specific to the logged in user, otherwise the ECM Adapter determines if it is common to a site or specific to a group or a user.

Returns:

an Alfresco Workdesk application object

Throws:

OwException - if the given object could not be retrieved

getApplicationObject

public OwSearchTemplate getApplicationObject(String strName_p,
                                    boolean forceUserSpecificObject_p,
                                    boolean createIfNotExist_p)
                                      throws OwException

Description copied from interface: OwAOManager

Returns the application object that is matched by the given name.

Parameters:

strName_p - name of the object to retrieve e.g. "userprefs"

forceUserSpecificObject_p - if true, the object must be specific to the logged in user, otherwise the ECM Adapter determines if it is common to a site or specific to a group or a user.

Returns:

an Alfresco Workdesk application object

Throws:

OwException - if the given object could not be retrieved

getApplicationObjects

public List<OwSearchTemplate> getApplicationObjects(String strName_p,
                                           boolean forceUserSpecificObject_p)
                                             throws OwException

Description copied from interface: OwAOManager

Returns all application objects that are matched by the given name.

Parameters:

strName_p - the

forceUserSpecificObject_p - if true, the object must be specific to the logged in user, otherwise the ECM Adapter determines if it is common to a site or specific to a group or a user.

Returns:

a collection of Alfresco Workdesk application objects

Throws:

OwException

getManagedType

public int getManagedType()

Returns:

the managed objects type integer code

getType

public OwAOType<?> getType()

initSearchTemplateFactory

protected OwSearchTemplateFactory initSearchTemplateFactory(OwAOContext context)

init

public void init(OwAOType<?> type,
        OwManagerConfiguration configuration,
        OwSupportsConfiguration supports,
        OwAOContext context)
          throws OwConfigurationException

Specified by:

init in interface OwConfigurableManager

Overrides:

init in class OwSupportBasedManager

Throws:

OwConfigurationException

toString

public String toString()

Overrides:

toString in class OwSupportBasedManager