Interface WorkflowBatchProxyManager
- All Superinterfaces:
AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable, WorkflowBatchProfile
The workflow batch proxy manager provides access to workflow batch
sessions and provides interoperability tests for various aspects of this
service. Methods in this manager support the passing of a Proxy .
The sessions included in this manager are:
-
ProcessBatchAdminSession: a session to manage processes in bulk -
StepBatchAdminSession: a session to manage steps in bulk -
WorkBatchAdminSession: a session to manage workd in bulk -
OfficeBatchAdminSession: a session to create, modify and deleteOfficesin bulk
-
Method Summary
Modifier and TypeMethodDescriptiongetOfficeBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk office administration service.getProcessBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk process administration service.getProcessBatchAdminSessionForOffice(Id officeId, Proxy proxy) Gets theOsidSessionassociated with the bulk process administration service for the given office.getStepBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk step administration service.getStepBatchAdminSessionForOffice(Id officeId, Proxy proxy) Gets theOsidSessionassociated with the bulk step administration service for the given office.getWorkBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk work administration service.getWorkBatchAdminSessionForOffice(Id officeId, Proxy proxy) Gets theOsidSessionassociated with the bulk work administration service for the given office.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.Methods inherited from interface WorkflowBatchProfile
supportsOfficeBatchAdmin, supportsProcessBatchAdmin, supportsStepBatchAdmin, supportsVisibleFederation, supportsWorkBatchAdminModifier and TypeMethodDescriptionbooleanTests if bulk administration of offices is available.booleanTests if bulk administration of processes is available.booleanTests if bulk administration of steps is available.booleanTests if federation is visible.booleanTests if bulk administration of works is available.
-
Method Details
-
getProcessBatchAdminSession
Gets theOsidSessionassociated with the bulk process administration service.- Parameters:
proxy- a proxy- Returns:
- a
ProcessBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsProcessBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsProcessBatchAdmin()} is {@code true} .
-
getProcessBatchAdminSessionForOffice
ProcessBatchAdminSession getProcessBatchAdminSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk process administration service for the given office.- Parameters:
officeId- theIdof theOfficeproxy- a proxy- Returns:
- a
ProcessBatchAdminSession - Throws:
NotFoundException- noOfficefound by the givenIdNullArgumentException-officeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsProcessBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsProcessBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getStepBatchAdminSession
Gets theOsidSessionassociated with the bulk step administration service.- Parameters:
proxy- a proxy- Returns:
- a
StepBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsStepBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsStepBatchAdmin()} is {@code true} .
-
getStepBatchAdminSessionForOffice
StepBatchAdminSession getStepBatchAdminSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk step administration service for the given office.- Parameters:
officeId- theIdof theOfficeproxy- a proxy- Returns:
- a
StepBatchAdminSession - Throws:
NotFoundException- noOfficefound by the givenIdNullArgumentException-officeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsStepBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsStepBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getWorkBatchAdminSession
Gets theOsidSessionassociated with the bulk work administration service.- Parameters:
proxy- a proxy- Returns:
- a
WorkBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsWorkBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkBatchAdmin()} is {@code true} .
-
getWorkBatchAdminSessionForOffice
WorkBatchAdminSession getWorkBatchAdminSessionForOffice(Id officeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk work administration service for the given office.- Parameters:
officeId- theIdof theOfficeproxy- a proxy- Returns:
- a
WorkBatchAdminSession - Throws:
NotFoundException- noOfficefound by the givenIdNullArgumentException-officeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsWorkBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getOfficeBatchAdminSession
Gets theOsidSessionassociated with the bulk office administration service.- Parameters:
proxy- a proxy- Returns:
- a
OfficeBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsOfficeBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsOfficeBatchAdmin()} is {@code true} .
-