public interface RelationshipBatchProxyManager extends OsidProxyManager, RelationshipBatchProfile
The relationship batch proxy manager provides access to relationship
batch sessions and provides interoperability tests for various aspects of
this service. Methods in this manager support the passing of a
Proxy
object. The sessions included in this manager are:
RelationshipBatchAdminSession:
a session to manage
relationshipd in bulk FamilyBatchAdminSession:
a session to create,
modify and delete Family
in bulk Modifier and Type | Method and Description |
---|---|
FamilyBatchAdminSession |
getFamilyBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk family
administration service. |
RelationshipBatchAdminSession |
getRelationshipBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk
relationship administration service. |
RelationshipBatchAdminSession |
getRelationshipBatchAdminSessionForFamily(Id familyId,
Proxy proxy)
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk
relationship administration service.proxy
- a proxy RelationshipBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRelationshipBatchAdmin()
is false
optional
- This method must be implemented if
supportsRelationshipBatchAdmin()
is true.
RelationshipBatchAdminSession getRelationshipBatchAdminSessionForFamily(Id familyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
relationship administration service for the given family.familyId
- the Id
of the Family
proxy
- a proxy RelationshipBatchAdminSession
NotFoundException
- no Family
found by
the given Id
NullArgumentException
- familyId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk family
administration service.proxy
- a proxy FamilyBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFamilyBatchAdmin()
is false
optional
- This method must be implemented if
supportsFamilyBatchAdmin()
is true.