Interface WorkflowEventManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, WorkflowEventProfile

public interface WorkflowEventManager
extends OsidManager, WorkflowEventProfile

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

• WorkflowEventLookupSession : a session to retrieve workflow events
• WorkflowEventQuerySession : a session to query for workflow events
• WorkflowEventSearchSession : a session to search for workflow events
• WorkflowEventAdminSession : a session to create and delete workflow events
• WorkflowEventNotificationSession : a session to receive notifications pertaining to workflow event changes
• WorkflowEventOfficeSession : a session to look up workflow event office mappings
• WorkflowEventOfficeAssignmentSession : a session to manage workflow event to office mappings
• WorkflowEventSmartOfficeSession : a session to manage dynamic offices of workflow events

Method Summary

Modifier and Type	Method	Description
WorkflowEventAdminSession	getWorkflowEventAdminSession()	Gets the OsidSession associated with the workflow event administration service.
WorkflowEventAdminSession	getWorkflowEventAdminSessionForOffice(Id officeId)	Gets the OsidSession associated with the workflow event administration service for the given office.
WorkflowEventLookupSession	getWorkflowEventLookupSession()	Gets the OsidSession associated with the workflow event lookup service.
WorkflowEventLookupSession	getWorkflowEventLookupSessionForOffice(Id officeId)	Gets the OsidSession associated with the workflow event lookup service for the given office.
WorkflowEventNotificationSession	getWorkflowEventNotificationSession(WorkflowEventReceiver workflowEventReceiver)	Gets the OsidSession associated with the workflow event notification service.
WorkflowEventNotificationSession	getWorkflowEventNotificationSessionForOffice(WorkflowEventReceiver workflowEventReceiver, Id officeId)	Gets the OsidSession associated with the workflow event notification service for the given office.
WorkflowEventOfficeAssignmentSession	getWorkflowEventOfficeAssignmentSession()	Gets the OsidSession associated with assigning workflow events to offices.
WorkflowEventOfficeSession	getWorkflowEventOfficeSession()	Gets the OsidSession to lookup workflow event/office mappings.
WorkflowEventQuerySession	getWorkflowEventQuerySession()	Gets the OsidSession associated with the workflow event query service.
WorkflowEventQuerySession	getWorkflowEventQuerySessionForOffice(Id officeId)	Gets the OsidSession associated with the workflow event query service for the given office.
WorkflowEventSearchSession	getWorkflowEventSearchSession()	Gets the OsidSession associated with the workflow event search service.
WorkflowEventSearchSession	getWorkflowEventSearchSessionForOffice(Id officeId)	Gets the OsidSession associated with the workflow event search service for the given office.
WorkflowEventSmartOfficeSession	getWorkflowEventSmartOfficeSession(Id officeId)	Gets the OsidSession to manage workflow event 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 WorkflowEventProfile

getWorkflowEventRecordTypes, getWorkflowEventSearchRecordTypes, supportsVisibleFederation, supportsWorkflowEventAdmin, supportsWorkflowEventLookup, supportsWorkflowEventNotification, supportsWorkflowEventOffice, supportsWorkflowEventOfficeAssignment, supportsWorkflowEventQuery, supportsWorkflowEventRecordType, supportsWorkflowEventSearch, supportsWorkflowEventSearchRecordType, supportsWorkflowEventSmartOffice

Modifier and Type	Method	Description
TypeList	getWorkflowEventRecordTypes()	Gets the supported WorkflowEvent record types.
TypeList	getWorkflowEventSearchRecordTypes()	Gets the supported WorkflowEvent search types.
boolean	supportsVisibleFederation()	Tests if any office federation is exposed.
boolean	supportsWorkflowEventAdmin()	Tests if a workflow event administrative service is supported.
boolean	supportsWorkflowEventLookup()	Tests if looking up workflow events is supported.
boolean	supportsWorkflowEventNotification()	Tests if a workflow event notification service is supported.
boolean	supportsWorkflowEventOffice()	Tests if a workflow event office lookup service is supported.
boolean	supportsWorkflowEventOfficeAssignment()	Tests if a workflow event office assignment service is supported.
boolean	supportsWorkflowEventQuery()	Tests if querying workflow events is supported.
boolean	supportsWorkflowEventRecordType(Type workflowEventRecordType)	Tests if the given WorkflowEvent record type is supported.
boolean	supportsWorkflowEventSearch()	Tests if searching workflow events is supported.
boolean	supportsWorkflowEventSearchRecordType(Type workflowEventSearchRecordType)	Tests if the given WorkflowEvent search type is supported.
boolean	supportsWorkflowEventSmartOffice()	Tests if a workflow event smart office service is supported.

Method Details

getWorkflowEventLookupSession

WorkflowEventLookupSession getWorkflowEventLookupSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the workflow event lookup service.

Returns:

a WorkflowEventLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventLookup() is false

Compliance:

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

getWorkflowEventLookupSessionForOffice

WorkflowEventLookupSession getWorkflowEventLookupSessionForOffice(Id officeId)
                                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the workflow event lookup service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a WorkflowEventLookupSession

Throws:

NotFoundException - no Office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventLookup() or supportsVisibleFederation() is false

Compliance:

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

getWorkflowEventQuerySession

WorkflowEventQuerySession getWorkflowEventQuerySession()
                                                throws OperationFailedException

Gets the OsidSession associated with the workflow event query service.

Returns:

a WorkflowEventQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventQuery() is false

Compliance:

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

getWorkflowEventQuerySessionForOffice

WorkflowEventQuerySession getWorkflowEventQuerySessionForOffice(Id officeId)
                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the workflow event query service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a WorkflowEventQuerySession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventQuery() or supportsVisibleFederation() is false

Compliance:

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

getWorkflowEventSearchSession

WorkflowEventSearchSession getWorkflowEventSearchSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the workflow event search service.

Returns:

a WorkflowEventSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventSearch() is false

Compliance:

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

getWorkflowEventSearchSessionForOffice

WorkflowEventSearchSession getWorkflowEventSearchSessionForOffice(Id officeId)
                                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the workflow event search service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a WorkflowEventSearchSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventSearch() or supportsVisibleFederation() is false

Compliance:

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

getWorkflowEventAdminSession

WorkflowEventAdminSession getWorkflowEventAdminSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the workflow event administration service.

Returns:

a WorkflowEventAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventAdmin() is false

Compliance:

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

getWorkflowEventAdminSessionForOffice

WorkflowEventAdminSession getWorkflowEventAdminSessionForOffice(Id officeId)
                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the workflow event administration service for the given office.

Parameters:

officeId - the Id of the Office

Returns:

a WorkflowEventAdminSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventAdmin() or supportsVisibleFederation() is false

Compliance:

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

getWorkflowEventNotificationSession

WorkflowEventNotificationSession getWorkflowEventNotificationSession(WorkflowEventReceiver workflowEventReceiver)
                                                              throws OperationFailedException

Gets the OsidSession associated with the workflow event notification service.

Parameters:

workflowEventReceiver - the notification callback

Returns:

a WorkflowEventNotificationSession

Throws:

NullArgumentException - workflowEventReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventNotification() is false

Compliance:

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

getWorkflowEventNotificationSessionForOffice

WorkflowEventNotificationSession getWorkflowEventNotificationSessionForOffice(WorkflowEventReceiver workflowEventReceiver,
 Id officeId)
                                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the workflow event notification service for the given office.

Parameters:

workflowEventReceiver - the notification callback

officeId - the Id of the Office

Returns:

a WorkflowEventNotificationSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - workflowEventReceiver or officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventNotification() or supportsVisibleFederation() is false

Compliance:

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

getWorkflowEventOfficeSession

WorkflowEventOfficeSession getWorkflowEventOfficeSession()
                                                  throws OperationFailedException

Gets the OsidSession to lookup workflow event/office mappings.

Returns:

a WorkflowEventOfficeSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventOffice() is false

Compliance:

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

getWorkflowEventOfficeAssignmentSession

WorkflowEventOfficeAssignmentSession getWorkflowEventOfficeAssignmentSession()
                                                                      throws OperationFailedException

Gets the OsidSession associated with assigning workflow events to offices.

Returns:

a WorkflowEventOfficeAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventOfficeAssignment() is false

Compliance:

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

getWorkflowEventSmartOfficeSession

WorkflowEventSmartOfficeSession getWorkflowEventSmartOfficeSession(Id officeId)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage workflow event smart offices.

Parameters:

officeId - the Id of the Office

Returns:

a WorkflowEventSmartOfficeSession

Throws:

NotFoundException - no office found by the given Id

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkflowEventSmartOffice() is false

Compliance:

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