com.wewebu.ow.server.ao

Interface OwAOSupport

All Known Implementing Classes:

OwFileAOSupport, OwRepositoryAOSupport

public interface OwAOSupport

An application OwObject provider. Implementors of this interface provide application objects as OwObjects from different persistence systems (egg. file system , ECM system ).

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

Method Summary

Methods

Modifier and Type	Method and Description
OwObject	getSupportObject(String strName_p, boolean forceUserspecificObject_p, boolean createIfNotExist_p) Returns the persistent application OwObject that is matched by the given name.
OwObject[]	getSupportObjects(String strName_p, boolean forceUserspecificObject_p, boolean createIfNotExist_p) Returns a collection of persistent application OwObjects that are matched by the given name.

Method Detail

getSupportObject

OwObject getSupportObject(String strName_p,
                        boolean forceUserspecificObject_p,
                        boolean createIfNotExist_p)
                          throws OwException

Returns the persistent application OwObject 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.

createIfNotExist_p - if true the object will be created if it does not exist

Returns:

an application object stored as OwObject

Throws:

OwException - if the given object could not be retrieved

getSupportObjects

OwObject[] getSupportObjects(String strName_p,
                           boolean forceUserspecificObject_p,
                           boolean createIfNotExist_p)
                             throws OwException

Returns a collection of persistent application OwObjects that are matched by the given name.

Parameters:

strName_p - name of the objects 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.

createIfNotExist_p - if true the objects container will be created if it does not exist

Returns:

a collection object stored as OwObject. Some entries might be null if the implementation of this support allows it (usually null entries signal objects that could not be retrieved).

Throws:

OwException - if the given object could not be retrieved