public interface ProfileBatchManager extends OsidManager, ProfileBatchProfile
The profile batch manager provides access to profile batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
ProfileEntryBatchSession:
a session to create,
modify and delete profile entries in bulk ProfileItemBatchAdminSession:
a session to create,
modify and delete profile items in bulk ProfileBatchAdminSession:
a session to create,
modify and delete profiles in bulk Modifier and Type | Method and Description |
---|---|
ProfileBatchAdminSession |
getProfileBatchAdminSession()
Gets the
OsidSession associated with the bulk profile
administration service. |
ProfileEntryBatchAdminSession |
getProfileEntryBatchAdminSession()
Gets the
OsidSession associated with the bulk profile
entry administration service. |
ProfileEntryBatchAdminSession |
getProfileEntryBatchAdminSessionForProfile(Id profileId)
Gets the
OsidSession associated with the bulk profile
entry administration service for the given profile. |
ProfileItemBatchAdminSession |
getProfileItemBatchAdminSession()
Gets the
OsidSession associated with the bulk profile
item administration service. |
ProfileItemBatchAdminSession |
getProfileItemBatchAdminSessionForProfile(Id profileId)
Gets the
OsidSession associated with the bulk profile
item administration service for the given profile. |
changeBranch, initialize, rollbackService
close
supportsProfileBatchAdmin, supportsProfileEntryBatchAdmin, supportsProfileItemBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ProfileEntryBatchAdminSession getProfileEntryBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk profile
entry administration service. ProfileEntryBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileEntryBatchAdmin()
is false
optional
- This method must be implemented if
supportsProfileEntryBatchAdmin()
is true.
ProfileEntryBatchAdminSession getProfileEntryBatchAdminSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk profile
entry administration service for the given profile.profileId
- the Id
of the Profile
ProfileEntryBatchAdminSession
NotFoundException
- no Profile
found by
the given Id
NullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileEntryBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProfileEntryBatchAdmin()
and
supportsVisibleFederation()
are true
ProfileItemBatchAdminSession getProfileItemBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk profile
item administration service. ProfileItemBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileItemBatchAdmin()
is false
optional
- This method must be implemented if
supportsProfileItemBatchAdmin()
is true.
ProfileItemBatchAdminSession getProfileItemBatchAdminSessionForProfile(Id profileId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk profile
item administration service for the given profile.profileId
- the Id
of the Profile
ProfileItemBatchAdminSession
NotFoundException
- no Profile
found by
the given Id
NullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileItemBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProfileItemBatchAdmin()
and
supportsVisibleFederation()
are true
ProfileBatchAdminSession getProfileBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk profile
administration service. ProfileBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileBatchAdmin()
is false
optional
- This method must be implemented if
supportsProfileBatchAdmin()
is true.