public interface RelationshipBatchManager extends OsidManager, RelationshipBatchProfile
The relationship batch manager provides access to relationship batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
RelationshipBatchAdminSession:
a session to
create, modify and delete Relationships in bulk FamilyBatchAdminSession:
a session to create,
modify and delete Family
in bulk Modifier and Type | Method and Description |
---|---|
FamilyBatchAdminSession |
getFamilyBatchAdminSession()
Gets the
OsidSession associated with the bulk family
administration service. |
RelationshipBatchAdminSession |
getRelationshipBatchAdminSession()
Gets the
OsidSession associated with the bulk
relationship administration service. |
RelationshipBatchAdminSession |
getRelationshipBatchAdminSessionForFamily(Id familyId)
Gets the
OsidSession associated with the bulk
relationship administration service for the given family. |
changeBranch, initialize, rollbackService
close
supportsFamilyBatchAdmin, supportsRelationshipBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
RelationshipBatchAdminSession getRelationshipBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk
relationship administration service. RelationshipBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipBatchAdmin()
is false
optional
- This method must be implemented if
supportsRelationshipBatchAdmin()
is true.
RelationshipBatchAdminSession getRelationshipBatchAdminSessionForFamily(Id familyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
relationship administration service for the given family.familyId
- the Id
of the Family
RelationshipBatchAdminSession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRelationshipBatchAdmin()
and
supportsVisibleFederation()
are true
FamilyBatchAdminSession getFamilyBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk family
administration service. FamilyBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFamilyBatchAdmin()
is false
optional
- This method must be implemented if
supportsFamilyBatchAdmin()
is true.