public interface ProfileBatchProxyManager extends OsidProxyManager, ProfileBatchProfile
The profile batch proxy manager provides access to profile 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:
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(Proxy proxy)
Gets the
OsidSession associated with the bulk profile
administration service. |
ProfileEntryBatchAdminSession |
getProfileEntryBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk profile
entry administration service. |
ProfileEntryBatchAdminSession |
getProfileEntryBatchAdminSessionForProfile(Id profileId,
Proxy proxy)
Gets the
OsidSession associated with the bulk profile
entry administration service for the given profile. |
ProfileItemBatchAdminSession |
getProfileItemBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk profile
item administration service. |
ProfileItemBatchAdminSession |
getProfileItemBatchAdminSessionForProfile(Id profileId,
Proxy proxy)
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk profile
entry administration service.proxy
- a proxy ProfileEntryBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileEntryBatchAdmin()
is false
optional
- This method must be implemented if
supportsProfileEntryBatchAdmin()
is true.
ProfileEntryBatchAdminSession getProfileEntryBatchAdminSessionForProfile(Id profileId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk profile
entry administration service for the given profile.profileId
- the Id
of the Profile
proxy
- a proxy ProfileEntryBatchAdminSession
NotFoundException
- no Profile
found by
the given Id
NullArgumentException
- profileId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk profile
item administration service.proxy
- a proxy ProfileItemBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileItemBatchAdmin()
is false
optional
- This method must be implemented if
supportsProfileItemBatchAdmin()
is true.
ProfileItemBatchAdminSession getProfileItemBatchAdminSessionForProfile(Id profileId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk profile
item administration service for the given profile.profileId
- the Id
of the Profile
proxy
- a proxy ProfileItemBatchAdminSession
NotFoundException
- no Profile
found by
the given Id
NullArgumentException
- profileId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk profile
administration service.proxy
- a proxy ProfileBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProfileBatchAdmin()
is false
optional
- This method must be implemented if
supportsProfileBatchAdmin()
is true.