public interface WorkflowBatchManager extends OsidManager, WorkflowBatchProfile
The workflow batch manager provides access to workflow batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
ProcessBatchAdminSession:
a session to create,
modify and delete Processes
in bulk StepBatchAdminSession:
a session to create, modify
and delete Steps in bulk WorkBatchAdminSession:
a session to create, modify
and delete Works in bulk OfficeBatchAdminSession:
a session to create,
modify and delete Offices
in bulk Modifier and Type | Method and Description |
---|---|
OfficeBatchAdminSession |
getOfficeBatchAdminSession()
Gets the
OsidSession associated with the bulk office
administration service. |
ProcessBatchAdminSession |
getProcessBatchAdminSession()
Gets the
OsidSession associated with the bulk process
administration service. |
ProcessBatchAdminSession |
getProcessBatchAdminSessionForOffice(Id officeId)
Gets the
OsidSession associated with the bulk process
administration service for the given office. |
StepBatchAdminSession |
getStepBatchAdminSession()
Gets the
OsidSession associated with the bulk step
administration service. |
StepBatchAdminSession |
getStepBatchAdminSessionForOffice(Id officeId)
Gets the
OsidSession associated with the bulk step
administration service for the given office. |
WorkBatchAdminSession |
getWorkBatchAdminSession()
Gets the
OsidSession associated with the bulk work
administration service. |
WorkBatchAdminSession |
getWorkBatchAdminSessionForOffice(Id officeId)
Gets the
OsidSession associated with the bulk work
administration service for the given office. |
changeBranch, initialize, rollbackService
close
supportsOfficeBatchAdmin, supportsProcessBatchAdmin, supportsStepBatchAdmin, supportsVisibleFederation, supportsWorkBatchAdmin
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ProcessBatchAdminSession getProcessBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk process
administration service. ProcessBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessBatchAdmin()
is false
optional
- This method must be implemented if
supportsProcessBatchAdmin()
is true.
ProcessBatchAdminSession getProcessBatchAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk process
administration service for the given office.officeId
- the Id
of the Office
ProcessBatchAdminSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProcessBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProcessBatchAdmin()
and
supportsVisibleFederation()
are true
StepBatchAdminSession getStepBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk step
administration service. StepBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepBatchAdmin()
is false
optional
- This method must be implemented if
supportsStepBatchAdmin()
is true.
StepBatchAdminSession getStepBatchAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk step
administration service for the given office.officeId
- the Id
of the Office
StepBatchAdminSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStepBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStepBatchAdmin()
and
supportsVisibleFederation()
are true
WorkBatchAdminSession getWorkBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk work
administration service. WorkBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkBatchAdmin()
is false
optional
- This method must be implemented if
supportsWorkBatchAdmin()
is true.
WorkBatchAdminSession getWorkBatchAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk work
administration service for the given office.officeId
- the Id
of the Office
WorkBatchAdminSession
NotFoundException
- no Office
found by
the given Id
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsWorkBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsWorkBatchAdmin()
and
supportsVisibleFederation()
are true
OfficeBatchAdminSession getOfficeBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk office
administration service. OfficeBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfficeBatchAdmin()
is false
optional
- This method must be implemented if
supportsOfficeBatchAdmin()
is true.