public interface OwNetwork<O extends OwObject> extends OwRepository<O>, OwAuthenticationProvider
Base interface for the network access. Covers access to all objects in the ECM system.
Covers access to the authentication provider as well.
NOTE: There is one instance of this class in each user session.
To be implemented with the specific 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
Modifier and Type | Field and Description |
---|---|
static int |
APPLICATION_OBJECT_TYPE_ATTRIBUTE_BAG
Deprecated.
since 4.2.0.0 use
OwAOTypesEnum.ATTRIBUTE_BAG |
static int |
APPLICATION_OBJECT_TYPE_ATTRIBUTE_BAG_ITERATOR
Deprecated.
since 4.2.0.0 use
OwAOTypesEnum.ATTRIBUTE_BAG_ITERATOR |
static int |
APPLICATION_OBJECT_TYPE_ATTRIBUTE_BAG_WRITABLE
Deprecated.
since 4.2.0.0 use
OwAOTypesEnum.ATTRIBUTE_BAG_WRITABLE |
static int |
APPLICATION_OBJECT_TYPE_ENTRY_TEMPLATE
Deprecated.
since 4.2.0.0 use
OwAOTypesEnum.ENTRY_TEMPLATE |
static int |
APPLICATION_OBJECT_TYPE_ENUM_COLLECTION
Deprecated.
since 4.2.0.0 use
OwAOTypesEnum.ENUM_COLLECTION |
static int |
APPLICATION_OBJECT_TYPE_INVERTED_ATTRIBUTE_BAG
Deprecated.
since 4.2.0.0 use
OwAOTypesEnum.INVERTED_ATTRIBUTE_BAG |
static int |
APPLICATION_OBJECT_TYPE_PREFERENCES
Deprecated.
since 4.2.0.0 use
OwAOTypesEnum.PREFERENCES |
static int |
APPLICATION_OBJECT_TYPE_SEARCHTEMPLATE
Deprecated.
since 4.2.0.0 use
OwAOTypesEnum |
static int |
APPLICATION_OBJECT_TYPE_USER_START
Deprecated.
since 4.2.0.0 use
OwAOTypesEnum.USER_START |
static int |
APPLICATION_OBJECT_TYPE_VIRTUAL_FOLDER
Deprecated.
since 4.2.0.0 use
OwAOTypesEnum.VIRTUAL_FOLDER |
static int |
APPLICATION_OBJECT_TYPE_XML_DOCUMENT
Deprecated.
since 4.2.0.0 use
OwAOTypesEnum.XML_DOCUMENT |
static int |
CAN_DO_FUNCTIONCODE_ACL_TO_MODIFY_ANNOTATION
function code used in canDo(...) method to check if user has the ACL to modify annotations, @since 3.2.0.1
|
static int |
CAN_DO_FUNCTIONCODE_CREATE_ANNOTATION
function code used in canDo(...) method to check if user can create annotations
|
static int |
CAN_DO_FUNCTIONCODE_DELETE_ANNOTATION
function code used in canDo(...) method to check if user can delete annotations
|
static int |
CAN_DO_FUNCTIONCODE_EDIT_ANNOTATION
function code used in canDo(...) method to check if user can edit annotations
|
static int |
CAN_DO_FUNCTIONCODE_PRINT
function code used in canDo(...) method to check if user can print the given object
|
static int |
CAN_DO_FUNCTIONCODE_SAVE_CONTENT_TO_DISK
function code used in canDo(...) method to check if user can save the content to disk
|
static int |
CAN_DO_FUNCTIONCODE_USER_START
user defined function codes start here
|
Modifier and Type | Method and Description |
---|---|
boolean |
canCreateNewObject(OwResource resource_p,
OwObject parent_p,
int iContext_p)
check, if Adapter can create a new objects
|
boolean |
canCreateObjectCopy(OwObject parent_p,
int[] childTypes_p,
int iContext_p)
creates a cloned object with new properties on the ECM system
|
boolean |
canDo(OwObject obj_p,
int iFunctionCode_p,
int iContext_p)
check if a extended function like print can be performed on the given object
|
boolean |
canEditAccessRights(OwObject object_p)
check if access rights can be edited on the Object.
|
String |
createNewObject(boolean fPromote_p,
Object mode_p,
OwResource resource_p,
String strObjectClassName_p,
OwPropertyCollection properties_p,
OwPermissionCollection permissions_p,
OwContentCollection content_p,
OwObject parent_p,
String strMimeType_p,
String strMimeParameter_p)
creates a new object on the ECM System using the given parameters
has additional promote and checkin mode parameters for versionable objects
|
String |
createNewObject(boolean fPromote_p,
Object mode_p,
OwResource resource_p,
String strObjectClassName_p,
OwPropertyCollection properties_p,
OwPermissionCollection permissions_p,
OwContentCollection content_p,
OwObject parent_p,
String strMimeType_p,
String strMimeParameter_p,
boolean fKeepCheckedOut_p)
Creates a new object on the ECM System using the given parameters.
Has additional promote and checkin mode parameters for versionable objects and the extra parameter fKeepCheckedOut_p to control whether the new objects are checked in automatically or not. |
String |
createNewObject(OwResource resource_p,
String strObjectClassName_p,
OwPropertyCollection properties_p,
OwPermissionCollection permissions_p,
OwContentCollection content_p,
OwObject parent_p,
String strMimeType_p,
String strMimeParameter_p)
creates a new object on the ECM System using the given parameters
|
String |
createObjectCopy(OwObject obj_p,
OwPropertyCollection properties_p,
OwPermissionCollection permissions_p,
OwObject parent_p,
int[] childTypes_p)
creates a cloned object with new properties on the ECM system
copies the content as well
|
OwObjectSkeleton |
createObjectSkeleton(OwObjectClass objectclass_p,
OwResource resource_p)
creates a new empty object which can be used to set properties and then submitted to the createNewObject function
|
Object |
getApplicationObject(int iTyp_p,
String strName_p,
boolean fForceUserSpecificObject_p,
boolean fCreateIfNotExist_p)
Deprecated.
since 4.2.0.0 use
OwAOProvider for application object retrieval |
Object |
getApplicationObject(int iTyp_p,
String strName_p,
Object param_p,
boolean fForceUserSpecificObject_p,
boolean fCreateIfNotExist_p)
Deprecated.
since 4.2.0.0 use
OwAOProvider for application object retrieval |
Collection |
getApplicationObjects(int iTyp_p,
String strName_p,
boolean fForceUserSpecificObject_p)
Deprecated.
since 4.2.0.0 use
OwAOProvider for application object retrieval |
OwNetworkContext |
getContext()
return the network context that was past during initialization
|
OwUIAccessRightsModul |
getEditAccessRightsSubModul(OwObject object_p)
get an instance of the edit access rights UI submodule for editing document access rights
Access rights are very specific to the ECM System and can not be handled generically
|
Object |
getInterface(String strInterfaceName_p,
Object oObject_p)
get an additional interface, e.g.
|
Locale |
getLocale()
get current locale
|
OwRoleManager |
getRoleManager() |
boolean |
hasInterface(String strInterfaceName_p)
check if an additional interface is available, e.g.
|
void |
init(OwNetworkContext context_p,
OwXMLUtil networkSettings_p)
initialize the network Adapter
|
void |
setEventManager(OwEventManager eventManager_p)
set the rolemanager to use
|
void |
setRoleManager(OwRoleManager roleManager_p)
set the rolemanager to use
|
canBatch, canPageSearch, canRefreshStaticClassdescriptions, closeBatch, doSearch, doSearch, getDMSPrefix, getEventManager, getObjectClass, getObjectClassNames, getObjectFromDMSID, getObjectFromPath, getResource, getResourceIDs, openBatch, refreshStaticClassdescriptions, releaseResources
getFieldDefinition, getWildCardDefinitions
canUserSelect, getCredentials, getLoginSubModul, getRoleDisplayName, getUserFromID, getUserSelectSubModul, loginDefault, logout
static final int APPLICATION_OBJECT_TYPE_VIRTUAL_FOLDER
OwAOTypesEnum.VIRTUAL_FOLDER
static final int APPLICATION_OBJECT_TYPE_PREFERENCES
OwAOTypesEnum.PREFERENCES
static final int APPLICATION_OBJECT_TYPE_SEARCHTEMPLATE
OwAOTypesEnum
static final int APPLICATION_OBJECT_TYPE_XML_DOCUMENT
OwAOTypesEnum.XML_DOCUMENT
static final int APPLICATION_OBJECT_TYPE_ATTRIBUTE_BAG
OwAOTypesEnum.ATTRIBUTE_BAG
static final int APPLICATION_OBJECT_TYPE_ATTRIBUTE_BAG_ITERATOR
OwAOTypesEnum.ATTRIBUTE_BAG_ITERATOR
static final int APPLICATION_OBJECT_TYPE_ATTRIBUTE_BAG_WRITABLE
OwAOTypesEnum.ATTRIBUTE_BAG_WRITABLE
static final int APPLICATION_OBJECT_TYPE_ENUM_COLLECTION
OwAOTypesEnum.ENUM_COLLECTION
static final int APPLICATION_OBJECT_TYPE_INVERTED_ATTRIBUTE_BAG
OwAOTypesEnum.INVERTED_ATTRIBUTE_BAG
static final int APPLICATION_OBJECT_TYPE_ENTRY_TEMPLATE
OwAOTypesEnum.ENTRY_TEMPLATE
static final int APPLICATION_OBJECT_TYPE_USER_START
OwAOTypesEnum.USER_START
static final int CAN_DO_FUNCTIONCODE_PRINT
static final int CAN_DO_FUNCTIONCODE_CREATE_ANNOTATION
static final int CAN_DO_FUNCTIONCODE_EDIT_ANNOTATION
static final int CAN_DO_FUNCTIONCODE_DELETE_ANNOTATION
static final int CAN_DO_FUNCTIONCODE_SAVE_CONTENT_TO_DISK
static final int CAN_DO_FUNCTIONCODE_ACL_TO_MODIFY_ANNOTATION
static final int CAN_DO_FUNCTIONCODE_USER_START
Object getInterface(String strInterfaceName_p, Object oObject_p) throws Exception
strInterfaceName_p
- Name of the interfaceoObject_p
- optional object to be wrappedException
boolean hasInterface(String strInterfaceName_p)
strInterfaceName_p
- Name of the interfaceLocale getLocale()
void init(OwNetworkContext context_p, OwXMLUtil networkSettings_p) throws Exception
context_p
- OwNetworkContextnetworkSettings_p
- Settings DOM Node wrapped by OwXMLUtilException
OwNetworkContext getContext()
void setRoleManager(OwRoleManager roleManager_p)
roleManager_p
- OwRoleManagervoid setEventManager(OwEventManager eventManager_p)
eventManager_p
- OwHistoryManager to write history to, only if ECM system does not write its own historyOwUIAccessRightsModul getEditAccessRightsSubModul(OwObject object_p) throws Exception
object_p
- OwObject to edit the access rightsException
boolean canEditAccessRights(OwObject object_p) throws Exception
object_p
- OwObject to edit access rights forException
Collection getApplicationObjects(int iTyp_p, String strName_p, boolean fForceUserSpecificObject_p) throws Exception
OwAOProvider
for application object retrievaliTyp_p
- type as defined in OwNetwork.APPLICATION_OBJECT_TYPE_...strName_p
- Name of the object to retrieve e.g. "userprefs"fForceUserSpecificObject_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.Exception
Object getApplicationObject(int iTyp_p, String strName_p, Object param_p, boolean fForceUserSpecificObject_p, boolean fCreateIfNotExist_p) throws Exception
OwAOProvider
for application object retrievaliTyp_p
- type as defined in OwNetwork.APPLICATION_OBJECT_TYPE_...strName_p
- Name of the object to retrieve e.g. "userprefs"param_p
- optional Object, can be nullfForceUserSpecificObject_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.fCreateIfNotExist_p
- boolean true = create if not existException
Object getApplicationObject(int iTyp_p, String strName_p, boolean fForceUserSpecificObject_p, boolean fCreateIfNotExist_p) throws Exception
OwAOProvider
for application object retrievaliTyp_p
- type as defined in OwNetwork.APPLICATION_OBJECT_TYPE_...strName_p
- Name of the object to retrieve e.g. "userprefs"fForceUserSpecificObject_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.fCreateIfNotExist_p
- boolean true = create if not existException
String createNewObject(OwResource resource_p, String strObjectClassName_p, OwPropertyCollection properties_p, OwPermissionCollection permissions_p, OwContentCollection content_p, OwObject parent_p, String strMimeType_p, String strMimeParameter_p) throws Exception
resource_p
- OwResource to add tostrObjectClassName_p
- requested class name of the new objectproperties_p
- OwPropertyCollection with new properties to set, or null to use defaultspermissions_p
- OwPermissionCollection ECM specific permissions or null to use defaultscontent_p
- OwContentCollection the new content to set, null to create an empty objectparent_p
- OwObject the parent object to use as a container, e.g. a folder or a ECM root, can be null if no parent is requiredstrMimeType_p
- String MIME Types of the new object contentstrMimeParameter_p
- extra info to the MIME typeException
String createNewObject(boolean fPromote_p, Object mode_p, OwResource resource_p, String strObjectClassName_p, OwPropertyCollection properties_p, OwPermissionCollection permissions_p, OwContentCollection content_p, OwObject parent_p, String strMimeType_p, String strMimeParameter_p) throws Exception
fPromote_p
- boolean true = create a released version right awaymode_p
- Object checkin mode for objects, see getCheckinModes, or null to use defaultresource_p
- OwResource to add tostrObjectClassName_p
- requested class name of the new objectproperties_p
- OwPropertyCollection with new properties to set, or null to use defaultspermissions_p
- OwPermissionCollection ECM specific permissions or null to use defaultscontent_p
- OwContentCollection the new content to set, null to create an empty objectparent_p
- OwObject the parent object to use as a container, e.g. a folder or a ECM root, can be null if no parent is requiredstrMimeType_p
- String MIME Types of the new object contentstrMimeParameter_p
- extra info to the MIME typeException
String createNewObject(boolean fPromote_p, Object mode_p, OwResource resource_p, String strObjectClassName_p, OwPropertyCollection properties_p, OwPermissionCollection permissions_p, OwContentCollection content_p, OwObject parent_p, String strMimeType_p, String strMimeParameter_p, boolean fKeepCheckedOut_p) throws Exception
ATTENTION: If keepCheckedOut is true
, the promote flag (major/minor versioning) is ignored.
fPromote_p
- boolean true = create a released version right awaymode_p
- Object checkin mode for objects, see getCheckinModes, or null to use defaultresource_p
- OwResource to add tostrObjectClassName_p
- requested class name of the new objectproperties_p
- OwPropertyCollection with new properties to set, or null to use defaultspermissions_p
- OwPermissionCollection ECM specific permissions or null to use defaultscontent_p
- OwContentCollection the new content to set, null to create an empty objectparent_p
- OwObject the parent object to use as a container, e.g. a folder or a ECM root, can be null if no parent is requiredstrMimeType_p
- String MIME Types of the new object contentstrMimeParameter_p
- extra info to the MIME typefKeepCheckedOut_p
- true = create a new object that is checked outException
boolean canCreateNewObject(OwResource resource_p, OwObject parent_p, int iContext_p) throws Exception
resource_p
- OwResource to add toparent_p
- OwObject the parent object to use as a container, e.g. a folder or a ECM root, can be null if no parent is requirediContext_p
- int as defined in OwStatusContextDefinitions
Exception
OwObjectSkeleton createObjectSkeleton(OwObjectClass objectclass_p, OwResource resource_p) throws Exception
objectclass_p
- OwObjectClass to create object fromresource_p
- OwResourceException
String createObjectCopy(OwObject obj_p, OwPropertyCollection properties_p, OwPermissionCollection permissions_p, OwObject parent_p, int[] childTypes_p) throws Exception
obj_p
- OwObject to create a copy ofproperties_p
- OwPropertyCollection of OwProperties to set, or null to keep propertiespermissions_p
- OwPermissionCollection of OwPermissions to set, or null to keep permissionsparent_p
- OwObject the parent object to use as a container, e.g. a folder or a ECM root, can be null if no parent is requiredchildTypes_p
- int types of the child objects to copy with the object, can be null if no children should be copiedException
boolean canCreateObjectCopy(OwObject parent_p, int[] childTypes_p, int iContext_p) throws Exception
parent_p
- OwObject the parent object to use as a container, e.g. a folder or a ECM root, can be null if no parent is requiredchildTypes_p
- int types of the child objects to copy with the object, can be null if no children should be copiediContext_p
- int as defined in OwStatusContextDefinitions
Exception
boolean canDo(OwObject obj_p, int iFunctionCode_p, int iContext_p) throws Exception
obj_p
- OwObject where function should be performed, or null if function does not require a objectiContext_p
- int as defined in OwStatusContextDefinitions
iFunctionCode_p
- int code of requested function as defined in CAN_DO_FUNCTIONCODE_...Exception
OwRoleManager getRoleManager()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.