public class CoreWorkspaceManager extends WorkspaceManagerImpl
WorkspaceManager
Constructor and Description |
---|
CoreWorkspaceManager() |
CoreWorkspaceManager(FdkSession session) |
Modifier and Type | Method and Description |
---|---|
Item |
createPersonalWorkspace(NamedValue[] def,
AttributeRequest[] attributes)
Creates a new personal workspace for the current user.
|
Item |
createPersonalWorkspaceForUser(long userId,
NamedValue[] def,
AttributeRequest[] attributes)
Creates a new personal workspace for the given user.
|
Item |
createWorkspace(long target,
NamedValue[] workflowParams,
NamedValue[] def,
AttributeRequest[] attributes)
Creates a new workspace or a request.
|
void |
deleteWorkspace(long id,
NamedValue[] def)
Deletes a workspace.
|
protected FdkSessionImpl |
getConnectedSession()
Return the web service session.
|
protected boolean |
isWebServiceCall()
Returns
true if the current call was made from a web services
client. |
Item |
joinWorkspace(long id,
long[] requestedRoles,
NamedValue[] wfParams,
AttributeRequest[] attributes)
Requests to join a JoinableWorkspace.
|
Item[] |
listJoinableWorkspaces(NamedValue[] options,
AttributeRequest[] attrs)
Lists workspaces that can be joined via request.
|
protected NamedValue[] |
login(FdkCredential c,
NamedValue[] options,
AttributeRequest[] userAttributes)
Internal login method used by web services login managers.
|
void |
referenceTypes(TypeReference ref)
Dummy web service method to create a reference to data types used
in the web services to insure that they are defined in the WSDL.
|
Item |
updateWorkspace(long id,
NamedValue[] def,
AttributeRequest[] attributes)
Updates an existing Workspace.
|
public CoreWorkspaceManager()
public CoreWorkspaceManager(FdkSession session)
public Item createWorkspace(long target, NamedValue[] workflowParams, NamedValue[] def, AttributeRequest[] attributes) throws FdkException
WorkspaceManager
If workflow is enabled AND 'CreateWorkspace' is workflow enabled, then an item of type 'REQUEST' is returned.
Otherwise, returns the created Workspace. can return null if the user ends up not having the ability to access the new Workspace.
Clients should check the type of the Item returned and act accordingly (If it's a request, inform user the request needs to be approved before the workspace can be created.).
The workspace definition also takes parameters for setting various configuration categories, including SECURITY_CONFIGURATION, VERSIONING_CONFIGURATION, RECORD_CONFIGURATION, and CATEGORY_CONFIGURATION. See the below pattern for SECURITY_CONFIGURATION and the Javadoc for the respective xxxManager.setxxxConfiguration methods.
To set a WORKFLOW_CONFIGURATION, use the patterns with Options.WORKFLOW_CONFIGURATION_DEFINITION as the top-level NamedValue, and add a NamedValue with Attributes.WORKFLOW_CONFIGURATION_OPERATION to specify the operation. Multiple WORKFLOW_CONFIGURATION_DEFINITIONs may be specified, each with a unique WORKFLOW_CONFIGURATION_OPERATION.
target
- the parent of the new workspace.workflowParams
- the parameters (name/value) needed to start workflow.def
- attributes for the Workspace.
attributes
- requested attributes for each item, or null.FdkException
- if the operation fails.public Item createPersonalWorkspace(NamedValue[] def, AttributeRequest[] attributes) throws FdkException
WorkspaceManager
def
- attributes for the workspace:
attributes
- requested attributes for each item, or null.FdkException
- if the operation fails.public Item createPersonalWorkspaceForUser(long userId, NamedValue[] def, AttributeRequest[] attributes) throws FdkException
WorkspaceManager
Can return null if the creator ends up not having the ability to access the new Workspace.
userId
- the ID of the user.def
- attributes for the workspace:
attributes
- requested attributes for each item, or null.FdkException
- if the operation fails.public Item updateWorkspace(long id, NamedValue[] def, AttributeRequest[] attributes) throws FdkException
WorkspaceManager
id
- the ID of the existing Workspace.def
- attributes to update:
attributes
- requested attributes for each item, or null.FdkException
- if the operation fails.public void deleteWorkspace(long id, NamedValue[] def) throws FdkException
WorkspaceManager
id
- the ID of the existing workspace.def
- attributes for the workspace.FdkException
- if the operation fails.public Item[] listJoinableWorkspaces(NamedValue[] options, AttributeRequest[] attrs) throws FdkException
WorkspaceManager
options
- Options on the retrieved list. Valid options are:
attrs
- attributes to return. Note that the DESCRIPTION
attribute will always return null on these objects.
To get the description of the Workspace, use the
JOINABLE_WORKSPACE_DESCRIPTION attribute.FdkException
- if the operation fails.public Item joinWorkspace(long id, long[] requestedRoles, NamedValue[] wfParams, AttributeRequest[] attributes) throws FdkException
WorkspaceManager
id
- the ID of the JoinableWorkspace to join.requestedRoles
- array of requested role IDs.wfParams
- the parameters (name/value) used to start workflow
the workflow parameter IFS_ECM_WORKFLOW_JUSTIFICATION
must be supplied for this call to succeed.attributes
- requested attributes from the resulting request.FdkException
- if the operation fails.protected final boolean isWebServiceCall()
true
if the current call was made from a web services
client. This check can be made by any subclasses in order to determine
functionality and restrictions based on the originating call. This
feature should be used lightly and only where really necessary as
this is not an idea way of implementing business logic.public void referenceTypes(TypeReference ref)
protected final NamedValue[] login(FdkCredential c, NamedValue[] options, AttributeRequest[] userAttributes) throws FdkException
FdkException
protected final FdkSessionImpl getConnectedSession() throws FdkException
FdkException
Copyright © 2023. All rights reserved.