Interface WorkflowManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, WorkflowProfile

public interface WorkflowManager
extends OsidManager, WorkflowProfile

The workflow manager provides access to rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• ProcessLookupSession : a session to retrieve processs
• ProcessQuerySession : a session to query for processs
• ProcessSearchSession : a session to search for processs
• ProcessAdminSession : a session to create and delete processs
• ProcessNotificationSession : a session to receive notifications pertaining to process changes
• ProcessOfficeSession : a session to looking mappings of process to offices
• ProcessOfficeAssignmentSession : a session to manage process to office workflows
• ProcessSmartOfficeSession : a session to manage dynamic offices of processs

• StepLookupSession : a session to retrieve steps
• StepQuerySession : a session to query for steps
• StepSearchSession : a session to search for steps
• StepAdminSession : a session to create and delete steps
• StepNotificationSession : a session to receive notifications pertaining to step changes
• StepOfficeSession : a session to look up step office mappings
• StepOfficeAssignmentSession : a session to manage steps to office mappings
• StepSmartOfficeSession : a session to manage dynamic offices of stepss

• WorkLookupSession : a session to retrieve work
• WorkQuerySession : a session to query for work
• WorkSearchSession : a session to search for work
• WorkAdminSession : a session to create and delete work
• WorkNotificationSession : a session to receive notifications pertaining to work changes
• WorkOfficeSession : a session to look up work office mappings
• WorkOfficeAssignmentSession : a session to manage availability to office mappings
• WorkSmartOfficeSession : a session to manage dynamic offices of work

• WorkflowSession : a session to examine work in a process
• WorkflowInitiationSession : a session to start work through a process
• WorkflowManagementSession : a session to enable and disable work in a process
• ManualWorkflowSession : a session to manuall assign work to steps in a process

• OfficeLookupSession : a session to retrieve offices
• OfficeQuerySession : a session to search for offices
• OfficeSearchSession : a session to search for offices
• OfficeAdminSession : a session to create and delete offices
• OfficeNotificationSession : a session to receive notifications pertaining to office changes
• OfficeHierarchySession : a session to traverse a hierarchy of office
• OfficeHierarchyDesignSession : a session to manage an office hierarchy

Method Summary

Modifier and Type	Method	Description
ManualWorkflowSession	getManualWorkflowSession()	Gets the OsidSession for a manual workflow service.
ManualWorkflowSession	getManualWorkflowSessionForOffice(Id officeId)	Gets the OsidSession for a manual workflow service for the given office.
OfficeAdminSession	getOfficeAdminSession()	Gets the OsidSession associated with the office administrative service.
OfficeHierarchyDesignSession	getOfficeHierarchyDesignSession()	Gets the OsidSession associated with the office hierarchy design service.
OfficeHierarchySession	getOfficeHierarchySession()	Gets the OsidSession associated with the office hierarchy service.
OfficeLookupSession	getOfficeLookupSession()	Gets the OsidSession associated with the office lookup service.
OfficeNotificationSession	getOfficeNotificationSession(OfficeReceiver officeReceiver)	Gets the OsidSession associated with the office notification service.
OfficeQuerySession	getOfficeQuerySession()	Gets the OsidSession associated with the office query service.
OfficeSearchSession	getOfficeSearchSession()	Gets the OsidSession associated with the office search service.
ProcessAdminSession	getProcessAdminSession()	Gets the OsidSession associated with the process administration service.
ProcessAdminSession	getProcessAdminSessionForOffice(Id officeId)	Gets the OsidSession associated with the process administration service for the given office.
ProcessLookupSession	getProcessLookupSession()	Gets the OsidSession associated with the process lookup service.
ProcessLookupSession	getProcessLookupSessionForOffice(Id officeId)	Gets the OsidSession associated with the process lookup service for the given office.
ProcessNotificationSession	getProcessNotificationSession(ProcessReceiver processReceiver)	Gets the OsidSession associated with the process notification service.
ProcessNotificationSession	getProcessNotificationSessionForOffice(ProcessReceiver processReceiver, Id officeId)	Gets the OsidSession associated with the process notification service for the given office.
ProcessOfficeAssignmentSession	getProcessOfficeAssignmentSession()	Gets the OsidSession associated with assigning process to offices.
ProcessOfficeSession	getProcessOfficeSession()	Gets the OsidSession to lookup process/office mappings.
ProcessQuerySession	getProcessQuerySession()	Gets the OsidSession associated with the process query service.
ProcessQuerySession	getProcessQuerySessionForOffice(Id officeId)	Gets the OsidSession associated with the process query service for the given office.
ProcessSearchSession	getProcessSearchSession()	Gets the OsidSession associated with the process search service.
ProcessSearchSession	getProcessSearchSessionForOffice(Id officeId)	Gets the OsidSession associated with the process search service for the given office.
ProcessSmartOfficeSession	getProcessSmartOfficeSession(Id officeId)	Gets the OsidSession to manage process smart offices.
StepAdminSession	getStepAdminSession()	Gets the OsidSession associated with the step administration service.
StepAdminSession	getStepAdminSessionForOffice(Id officeId)	Gets the OsidSession associated with the step administration service for the given office.
StepLookupSession	getStepLookupSession()	Gets the OsidSession associated with the step lookup service.
StepLookupSession	getStepLookupSessionForOffice(Id officeId)	Gets the OsidSession associated with the step lookup service for the given office.
StepNotificationSession	getStepNotificationSession(StepReceiver stepReceiver)	Gets the OsidSession associated with the step notification service.
StepNotificationSession	getStepNotificationSessionForOffice(StepReceiver stepReceiver, Id officeId)	Gets the OsidSession associated with the step notification service for the given office.
StepOfficeAssignmentSession	getStepOfficeAssignmentSession()	Gets the OsidSession associated with assigning steps to offices.
StepOfficeSession	getStepOfficeSession()	Gets the OsidSession to lookup step/office mappings.
StepQuerySession	getStepQuerySession()	Gets the OsidSession associated with the step query service.
StepQuerySession	getStepQuerySessionForOffice(Id officeId)	Gets the OsidSession associated with the step query service for the given office.
StepSearchSession	getStepSearchSession()	Gets the OsidSession associated with the step search service.
StepSearchSession	getStepSearchSessionForOffice(Id officeId)	Gets the OsidSession associated with the step search service for the given office.
StepOfficeSession	getStepSmartOfficeSession(Id officeId)	Gets the OsidSession to manage step smart offices.
WorkAdminSession	getWorkAdminSession()	Gets the OsidSession associated with the work administration service.
WorkAdminSession	getWorkAdminSessionForOffice(Id officeId)	Gets the OsidSession associated with the work administration service for the given office.
WorkflowBatchManager	getWorkflowBatchManager()	Gets a WorkflowBatchManager .
WorkflowEventManager	getWorkflowEventManager()	Gets a WorkflowEventManager .
WorkflowInitiationSession	getWorkflowInitiationSession()	Gets the OsidSession for a workflow initiation service.
WorkflowInitiationSession	getWorkflowInitiationSessionForOffice(Id officeId)	Gets the OsidSession for a workflow initiation service for the given office.
WorkflowManagementSession	getWorkflowManagementSession()	Gets the OsidSession for a workflow management service.
WorkflowManagementSession	getWorkflowManagementSessionForOffice(Id officeId)	Gets the OsidSession for a workflow management service for the given office.
WorkflowRulesManager	getWorkflowRulesManager()	Gets a WorkflowRulesManager .
WorkflowSession	getWorkflowSession()	Gets the OsidSession for a workflow service.
WorkflowSession	getWorkflowSessionForOffice(Id officeId)	Gets the OsidSession for a workflow service for the given office.
WorkLookupSession	getWorkLookupSession()	Gets the OsidSession associated with the work lookup service.
WorkLookupSession	getWorkLookupSessionForOffice(Id officeId)	Gets the OsidSession associated with the work lookup service for the given office.
WorkNotificationSession	getWorkNotificationSession(WorkReceiver workReceiver)	Gets the OsidSession associated with the work notification service.
WorkNotificationSession	getWorkNotificationSessionForOffice(WorkReceiver workReceiver, Id officeId)	Gets the OsidSession associated with the work notification service for the given office.
WorkOfficeAssignmentSession	getWorkOfficeAssignmentSession()	Gets the OsidSession associated with assigning work to offices.
WorkOfficeSession	getWorkOfficeSession()	Gets the OsidSession to lookup work/office mappings.
WorkQuerySession	getWorkQuerySession()	Gets the OsidSession associated with the work query service.
WorkQuerySession	getWorkQuerySessionForOffice(Id officeId)	Gets the OsidSession associated with the work query service for the given office.
WorkSearchSession	getWorkSearchSession()	Gets the OsidSession associated with the work search service.
WorkSearchSession	getWorkSearchSessionForOffice(Id officeId)	Gets the OsidSession associated with the work search service for the given office.
WorkSmartOfficeSession	getWorkSmartOfficeSession(Id officeId)	Gets the OsidSession to manage work smart offices.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Methods inherited from interface WorkflowProfile

getOfficeRecordTypes, getOfficeSearchRecordTypes, getProcessRecordTypes, getProcessSearchRecordTypes, getStepRecordTypes, getStepSearchRecordTypes, getWorkRecordTypes, getWorkSearchRecordTypes, supportsManualWorkflow, supportsOfficeAdmin, supportsOfficeHierarchy, supportsOfficeHierarchyDesign, supportsOfficeLookup, supportsOfficeNotification, supportsOfficeQuery, supportsOfficeRecordType, supportsOfficeSearch, supportsOfficeSearchRecordType, supportsProcessAdmin, supportsProcessLookup, supportsProcessNotification, supportsProcessOffice, supportsProcessOfficeAssignment, supportsProcessQuery, supportsProcessRecordType, supportsProcessSearch, supportsProcessSearchRecordType, supportsProcessSmartOffice, supportsStepAdmin, supportsStepLookup, supportsStepNotification, supportsStepOffice, supportsStepOfficeAssignment, supportsStepQuery, supportsStepRecordType, supportsStepSearch, supportsStepSearchRecordType, supportsStepSmartOffice, supportsVisibleFederation, supportsWorkAdmin, supportsWorkflow, supportsWorkflowBatch, supportsWorkflowEvents, supportsWorkflowInitiation, supportsWorkflowManagement, supportsWorkflowRules, supportsWorkLookup, supportsWorkNotification, supportsWorkOffice, supportsWorkOfficeAssignment, supportsWorkQuery, supportsWorkRecordType, supportsWorkSearch, supportsWorkSearchRecordType, supportsWorkSmartOffice

Modifier and Type	Method	Description
TypeList	getOfficeRecordTypes()	Gets the supported Office record types.
TypeList	getOfficeSearchRecordTypes()	Gets the supported Office search record types.
TypeList	getProcessRecordTypes()	Gets the supported Process record types.
TypeList	getProcessSearchRecordTypes()	Gets the supported Process search record types.
TypeList	getStepRecordTypes()	Gets the supported Step record types.
TypeList	getStepSearchRecordTypes()	Gets the supported Step search types.
TypeList	getWorkRecordTypes()	Gets the supported Work record types.
TypeList	getWorkSearchRecordTypes()	Gets the supported Work search record types.
boolean	supportsManualWorkflow()	Tests if a manual workflow service is supported.
boolean	supportsOfficeAdmin()	Tests if office administrative service is supported.
boolean	supportsOfficeHierarchy()	Tests for the availability of an office hierarchy traversal service.
boolean	supportsOfficeHierarchyDesign()	Tests for the availability of an office hierarchy design service.
boolean	supportsOfficeLookup()	Tests if looking up offices is supported.
boolean	supportsOfficeNotification()	Tests if an office notification service is supported.
boolean	supportsOfficeQuery()	Tests if querying offices is supported.
boolean	supportsOfficeRecordType(Type officeRecordType)	Tests if the given Office record type is supported.
boolean	supportsOfficeSearch()	Tests if searching offices is supported.
boolean	supportsOfficeSearchRecordType(Type officeSearchRecordType)	Tests if the given Office search record type is supported.
boolean	supportsProcessAdmin()	Tests if process administrative service is supported.
boolean	supportsProcessLookup()	Tests if looking up process is supported.
boolean	supportsProcessNotification()	Tests if a process notification service is supported.
boolean	supportsProcessOffice()	Tests if a process office lookup service is supported.
boolean	supportsProcessOfficeAssignment()	Tests if a process office service is supported.
boolean	supportsProcessQuery()	Tests if querying process is supported.
boolean	supportsProcessRecordType(Type processRecordType)	Tests if the given Process record type is supported.
boolean	supportsProcessSearch()	Tests if searching process is supported.
boolean	supportsProcessSearchRecordType(Type processSearchRecordType)	Tests if the given Process search record type is supported.
boolean	supportsProcessSmartOffice()	Tests if a process smart office lookup service is supported.
boolean	supportsStepAdmin()	Tests if a step administrative service is supported.
boolean	supportsStepLookup()	Tests if looking up steps is supported.
boolean	supportsStepNotification()	Tests if a step notification service is supported.
boolean	supportsStepOffice()	Tests if a step office lookup service is supported.
boolean	supportsStepOfficeAssignment()	Tests if a step office assignment service is supported.
boolean	supportsStepQuery()	Tests if querying steps is supported.
boolean	supportsStepRecordType(Type stepRecordType)	Tests if the given Step record type is supported.
boolean	supportsStepSearch()	Tests if searching steps is supported.
boolean	supportsStepSearchRecordType(Type stepSearchRecordType)	Tests if the given Step search type is supported.
boolean	supportsStepSmartOffice()	Tests if a step smart office service is supported.
boolean	supportsVisibleFederation()	Tests if any office federation is exposed.
boolean	supportsWorkAdmin()	Tests if work administrative service is supported.
boolean	supportsWorkflow()	Tests if a workflow service is supported.
boolean	supportsWorkflowBatch()	Tests for the availability of a workflow batch service.
boolean	supportsWorkflowEvents()	Tests for the availability of a workflow events service.
boolean	supportsWorkflowInitiation()	Tests if a workflow initiation service is supported.
boolean	supportsWorkflowManagement()	Tests if a workflow management service is supported.
boolean	supportsWorkflowRules()	Tests for the availability of a workflow rules service.
boolean	supportsWorkLookup()	Tests if looking up work is supported.
boolean	supportsWorkNotification()	Tests if a work notification service is supported.
boolean	supportsWorkOffice()	Tests if a work office lookup service is supported.
boolean	supportsWorkOfficeAssignment()	Tests if a work office service is supported.
boolean	supportsWorkQuery()	Tests if querying work is supported.
boolean	supportsWorkRecordType(Type workRecordType)	Tests if the given Work record type is supported.
boolean	supportsWorkSearch()	Tests if searching work is supported.
boolean	supportsWorkSearchRecordType(Type workSearchRecordType)	Tests if the given Work search record type is supported.
boolean	supportsWorkSmartOffice()	Tests if a work smart office lookup service is supported.

Method Details

getProcessLookupSession

ProcessLookupSession getProcessLookupSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the process lookup service.

Returns:

a ProcessLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessLookup()} is {@code true} .

getProcessLookupSessionForOffice

ProcessLookupSession getProcessLookupSessionForOffice(Id officeId)
                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process lookup service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a ProcessLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessLookup()} and {@code supportsVisibleFederation()} are {@code true}

getProcessQuerySession

ProcessQuerySession getProcessQuerySession()
                                    throws OperationFailedException

Gets the OsidSession associated with the process query service.

Returns:

a ProcessQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessQuery()} is {@code true} .

getProcessQuerySessionForOffice

ProcessQuerySession getProcessQuerySessionForOffice(Id officeId)
                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process query service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a ProcessQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessQuery()} and {@code supportsVisibleFederation()} are {@code true}

getProcessSearchSession

ProcessSearchSession getProcessSearchSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the process search service.

Returns:

a ProcessSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessSearch()} is {@code true} .

getProcessSearchSessionForOffice

ProcessSearchSession getProcessSearchSessionForOffice(Id officeId)
                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process search service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a ProcessSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessSearch()} and {@code supportsVisibleFederation()} are {@code true}

getProcessAdminSession

ProcessAdminSession getProcessAdminSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the process administration service.

Returns:

a ProcessAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessAdmin()} is {@code true} .

getProcessAdminSessionForOffice

ProcessAdminSession getProcessAdminSessionForOffice(Id officeId)
                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process administration service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a ProcessAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getProcessNotificationSession

ProcessNotificationSession getProcessNotificationSession(ProcessReceiver processReceiver)
                                                  throws OperationFailedException

Gets the OsidSession associated with the process notification service.

Parameters:

processReceiver - the notification callback

Returns:

a ProcessNotificationSession

Throws:

NullArgumentException - processReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessNotification()} is {@code true} .

getProcessNotificationSessionForOffice

ProcessNotificationSession getProcessNotificationSessionForOffice(ProcessReceiver processReceiver,
 Id officeId)
                                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the process notification service for the given office.

Parameters:

processReceiver - the notification callback

officeId - the Id of the Office

Returns:

a ProcessNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - processReceiver or officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessNotification()} and {@code supportsVisibleFederation()} are {@code true}

getProcessOfficeSession

ProcessOfficeSession getProcessOfficeSession()
                                      throws OperationFailedException

Gets the OsidSession to lookup process/office mappings.

Returns:

a ProcessOfficeSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessOffice()} is {@code true} .

getProcessOfficeAssignmentSession

ProcessOfficeAssignmentSession getProcessOfficeAssignmentSession()
                                                          throws OperationFailedException

Gets the OsidSession associated with assigning process to offices.

Returns:

a ProcessOfficeAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessOfficeAssignment()} is {@code true} .

getProcessSmartOfficeSession

ProcessSmartOfficeSession getProcessSmartOfficeSession(Id officeId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage process smart offices.

Parameters:

officeId - the Id of the Office

Returns:

a ProcessSmartOfficeSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcessSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsProcessSmartOffice()} is {@code true} .

getStepLookupSession

StepLookupSession getStepLookupSession()
                                throws OperationFailedException

Gets the OsidSession associated with the step lookup service.

Returns:

a StepLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStepLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsStepLookup()} is {@code true} .

getStepLookupSessionForOffice

StepLookupSession getStepLookupSessionForOffice(Id officeId)
                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step lookup service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a StepLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepLookup()} and {@code supportsVisibleFederation()} are {@code true}

getStepQuerySession

StepQuerySession getStepQuerySession()
                              throws OperationFailedException

Gets the OsidSession associated with the step query service.

Returns:

a StepQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStepQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsStepQuery()} is {@code true} .

getStepQuerySessionForOffice

StepQuerySession getStepQuerySessionForOffice(Id officeId)
                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step query service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a StepQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepQuery()} and {@code supportsVisibleFederation()} are {@code true}

getStepSearchSession

StepSearchSession getStepSearchSession()
                                throws OperationFailedException

Gets the OsidSession associated with the step search service.

Returns:

a StepSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStepSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsStepSearch()} is {@code true} .

getStepSearchSessionForOffice

StepSearchSession getStepSearchSessionForOffice(Id officeId)
                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step search service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a StepSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepSearch()} and {@code supportsVisibleFederation()} are {@code true}

getStepAdminSession

StepAdminSession getStepAdminSession()
                              throws OperationFailedException

Gets the OsidSession associated with the step administration service.

Returns:

a StepAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStepAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsStepAdmin()} is {@code true} .

getStepAdminSessionForOffice

StepAdminSession getStepAdminSessionForOffice(Id officeId)
                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step administration service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a StepAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getStepNotificationSession

StepNotificationSession getStepNotificationSession(StepReceiver stepReceiver)
                                            throws OperationFailedException

Gets the OsidSession associated with the step notification service.

Parameters:

stepReceiver - the notification callback

Returns:

a StepNotificationSession

Throws:

NullArgumentException - stepReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsStepNotification()} is {@code true} .

getStepNotificationSessionForOffice

StepNotificationSession getStepNotificationSessionForOffice(StepReceiver stepReceiver,
 Id officeId)
                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the step notification service for the given office.

Parameters:

stepReceiver - the notification callback

officeId - the Id of the Office

Returns:

a StepNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - stepReceiver or officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsStepNotification()} and {@code supportsVisibleFederation()} are {@code true}

getStepOfficeSession

StepOfficeSession getStepOfficeSession()
                                throws OperationFailedException

Gets the OsidSession to lookup step/office mappings.

Returns:

a StepOfficeSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStepOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsStepOffice()} is {@code true} .

getStepOfficeAssignmentSession

StepOfficeAssignmentSession getStepOfficeAssignmentSession()
                                                    throws OperationFailedException

Gets the OsidSession associated with assigning steps to offices.

Returns:

a StepOfficeAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStepOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsStepOfficeAssignment()} is {@code true} .

getStepSmartOfficeSession

StepOfficeSession getStepSmartOfficeSession(Id officeId)
                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage step smart offices.

Parameters:

officeId - the Id of the Office

Returns:

a StepSmartOfficeSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStepSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsStepSmartOffice()} is {@code true} .

getWorkLookupSession

WorkLookupSession getWorkLookupSession()
                                throws OperationFailedException

Gets the OsidSession associated with the work lookup service.

Returns:

a WorkLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkLookup()} is {@code true} .

getWorkLookupSessionForOffice

WorkLookupSession getWorkLookupSessionForOffice(Id officeId)
                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the work lookup service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a WorkLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkLookup()} and {@code supportsVisibleFederation()} are {@code true}

getWorkQuerySession

WorkQuerySession getWorkQuerySession()
                              throws OperationFailedException

Gets the OsidSession associated with the work query service.

Returns:

a WorkQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkQuery()} is {@code true} .

getWorkQuerySessionForOffice

WorkQuerySession getWorkQuerySessionForOffice(Id officeId)
                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the work query service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a WorkQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkQuery()} and {@code supportsVisibleFederation()} are {@code true}

getWorkSearchSession

WorkSearchSession getWorkSearchSession()
                                throws OperationFailedException

Gets the OsidSession associated with the work search service.

Returns:

a WorkSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkSearch()} is {@code true} .

getWorkSearchSessionForOffice

WorkSearchSession getWorkSearchSessionForOffice(Id officeId)
                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the work search service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a WorkSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkSearch()} and {@code supportsVisibleFederation()} are {@code true}

getWorkAdminSession

WorkAdminSession getWorkAdminSession()
                              throws OperationFailedException

Gets the OsidSession associated with the work administration service.

Returns:

a WorkAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkAdmin()} is {@code true} .

getWorkAdminSessionForOffice

WorkAdminSession getWorkAdminSessionForOffice(Id officeId)
                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the work administration service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a WorkAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getWorkNotificationSession

WorkNotificationSession getWorkNotificationSession(WorkReceiver workReceiver)
                                            throws OperationFailedException

Gets the OsidSession associated with the work notification service.

Parameters:

workReceiver - the notification callback

Returns:

a WorkNotificationSession

Throws:

NullArgumentException - workReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkNotification()} is {@code true} .

getWorkNotificationSessionForOffice

WorkNotificationSession getWorkNotificationSessionForOffice(WorkReceiver workReceiver,
 Id officeId)
                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the work notification service for the given office.

Parameters:

workReceiver - the notification callback

officeId - the Id of the Office

Returns:

a WorkNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - workReceiver or officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkNotification()} and {@code supportsVisibleFederation()} are {@code true}

getWorkOfficeSession

WorkOfficeSession getWorkOfficeSession()
                                throws OperationFailedException

Gets the OsidSession to lookup work/office mappings.

Returns:

a WorkOfficeSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkOffice()} is {@code true} .

getWorkOfficeAssignmentSession

WorkOfficeAssignmentSession getWorkOfficeAssignmentSession()
                                                    throws OperationFailedException

Gets the OsidSession associated with assigning work to offices.

Returns:

a WorkOfficeAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkbOfficeAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkOfficeAssignment()} is {@code true} .

getWorkSmartOfficeSession

WorkSmartOfficeSession getWorkSmartOfficeSession(Id officeId)
                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage work smart offices.

Parameters:

officeId - the Id of the Office

Returns:

a WorkSmartOfficeSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkSmartOffice() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkSmartOffice()} is {@code true} .

getWorkflowSession

WorkflowSession getWorkflowSession()
                            throws OperationFailedException

Gets the OsidSession for a workflow service.

Returns:

a WorkflowSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflow() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkflow()} is {@code true} .

getWorkflowSessionForOffice

WorkflowSession getWorkflowSessionForOffice(Id officeId)
                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession for a workflow service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a WorkflowSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflow() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkflow()} and {@code supportsVisibleFederation()} are {@code true}

getWorkflowInitiationSession

WorkflowInitiationSession getWorkflowInitiationSession()
                                                throws OperationFailedException

Gets the OsidSession for a workflow initiation service.

Returns:

a WorkflowInitiationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowInitiation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkflowInitiation()} is {@code true} .

getWorkflowInitiationSessionForOffice

WorkflowInitiationSession getWorkflowInitiationSessionForOffice(Id officeId)
                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession for a workflow initiation service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a WorkflowInitiationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - offiecId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowInitiation() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkflowInitiation()} and {@code supportsVisibleFederation()} are {@code true}

getWorkflowManagementSession

WorkflowManagementSession getWorkflowManagementSession()
                                                throws OperationFailedException

Gets the OsidSession for a workflow management service.

Returns:

a WorkflowManagementSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowManagement() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkflowManagement()} is {@code true} .

getWorkflowManagementSessionForOffice

WorkflowManagementSession getWorkflowManagementSessionForOffice(Id officeId)
                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession for a workflow management service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a WorkflowManagementSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowManagement() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkflowManagement()} and {@code supportsVisibleFederation()} are {@code true}

getManualWorkflowSession

ManualWorkflowSession getManualWorkflowSession()
                                        throws OperationFailedException

Gets the OsidSession for a manual workflow service.

Returns:

a ManualWorkflowSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsManualWorkflow() is false

Compliance:

optional - This method must be implemented if {@code supportsManualWorkflow()} is {@code true} .

getManualWorkflowSessionForOffice

ManualWorkflowSession getManualWorkflowSessionForOffice(Id officeId)
                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession for a manual workflow service for the given office.

Parameters:

officeId - the Id of the office

Returns:

a ManualWorkflowSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsManualWorkflow() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsManualWorkflow()} and {@code supportsVisibleFederation()} are {@code true}

getOfficeLookupSession

OfficeLookupSession getOfficeLookupSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the office lookup service.

Returns:

an OfficeLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsOfficeLookup()} is {@code true} .

getOfficeQuerySession

OfficeQuerySession getOfficeQuerySession()
                                  throws OperationFailedException

Gets the OsidSession associated with the office query service.

Returns:

an OfficeQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsOfficeQuery()} is {@code true} .

getOfficeSearchSession

OfficeSearchSession getOfficeSearchSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the office search service.

Returns:

an OfficeSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsOfficeSearch()} is {@code true} .

getOfficeAdminSession

OfficeAdminSession getOfficeAdminSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the office administrative service.

Returns:

an OfficeAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsOfficeAdmin()} is {@code true} .

getOfficeNotificationSession

OfficeNotificationSession getOfficeNotificationSession(OfficeReceiver officeReceiver)
                                                throws OperationFailedException

Gets the OsidSession associated with the office notification service.

Parameters:

officeReceiver - the notification callback

Returns:

an OfficeNotificationSession

Throws:

NullArgumentException - officeReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsOfficeNotification()} is {@code true} .

getOfficeHierarchySession

OfficeHierarchySession getOfficeHierarchySession()
                                          throws OperationFailedException

Gets the OsidSession associated with the office hierarchy service.

Returns:

an OfficeHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsOfficeHierarchy()} is {@code true} .

getOfficeHierarchyDesignSession

OfficeHierarchyDesignSession getOfficeHierarchyDesignSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with the office hierarchy design service.

Returns:

a HierarchyDesignSession for offices

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfficeHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsOfficeHierarchyDesign()} is {@code true} .

getWorkflowBatchManager

WorkflowBatchManager getWorkflowBatchManager()
                                      throws OperationFailedException

Gets a WorkflowBatchManager .

Returns:

a WorkflowbatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkflowBatch()} is {@code true} .

getWorkflowRulesManager

WorkflowRulesManager getWorkflowRulesManager()
                                      throws OperationFailedException

Gets a WorkflowRulesManager .

Returns:

a WorkflowRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowRules() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkflowRules()} is {@code true} .

getWorkflowEventManager

WorkflowEventManager getWorkflowEventManager()
                                      throws OperationFailedException

Gets a WorkflowEventManager .

Returns:

a WorkflowEventManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEvents() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkflowEvents()} is {@code true} .