public interface OfferingConstrainerEnablerCatalogueAssignmentSession extends OsidSession
This session provides methods to re-assign
OfferingConstrainerEnabler
to Catalogue
mappings.
An OfferingConstrainerEnabler
may appear in multiple
Catalogue
objects and removing the last reference to an
OfferingConstrainerEnabler
is the equivalent of deleting it. Each
Catalogue
may have its own authorizations governing who is
allowed to operate on it.
Adding a reference of an OfferingConstrainerEnabler
to
another Catalogue
is not a copy operation (eg: does not
change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignOfferingConstrainerEnablerToCatalogue(Id offeringConstrainerEnablerId,
Id catalogueId)
Adds an existing
OfferingConstrainerEnabler to a
Catalogue. |
boolean |
canAssignOfferingConstrainerEnablers()
Tests if this user can alter offering constrainer enabler/catalogue
mappings.
|
boolean |
canAssignOfferingConstrainerEnablersToCatalogue(Id catalogueId)
Tests if this user can alter offering constrainer enabler/catalogue
mappings.
|
IdList |
getAssignableCatalogueIds(Id catalogueId)
Gets a list of catalogues including and under the given catalogue node
in which any offering constrainer enabler can be assigned.
|
IdList |
getAssignableCatalogueIdsForOfferingConstrainerEnabler(Id catalogueId,
Id offeringConstrainerEnablerId)
Gets a list of catalogues including and under the given catalogue node
in which a specific offering constrainer enabler can be assigned.
|
void |
reassignOfferingConstrainerEnablerToCatalogue(Id offeringConstrainerEnablerId,
Id fromCatalogueId,
Id toCatalogueId)
Moves an
OfferingConstrainerEnabler from one
Catalogue to another. |
void |
unassignOfferingConstrainerEnablerFromCatalogue(Id offeringConstrainerEnablerId,
Id catalogueId)
Removes an
OfferingConstrainerEnabler from a
Catalogue. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignOfferingConstrainerEnablers()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignOfferingConstrainerEnablersToCatalogue(Id catalogueId)
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users.catalogueId
- the Id
of the Catalogue
false
if mapping is not authorized, true
otherwiseNullArgumentException
- catalogueId
is
null
mandatory
- This method must be implemented. IdList getAssignableCatalogueIds(Id catalogueId) throws OperationFailedException
catalogueId
- the Id
of the Catalogue
Ids
NullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableCatalogueIdsForOfferingConstrainerEnabler(Id catalogueId, Id offeringConstrainerEnablerId) throws OperationFailedException
catalogueId
- the Id
of the Catalogue
offeringConstrainerEnablerId
- the Id
of the
OfferingConstrainerEnabler
Ids
NullArgumentException
- catalogueId
or
offeringConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignOfferingConstrainerEnablerToCatalogue(Id offeringConstrainerEnablerId, Id catalogueId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainerEnabler
to a
Catalogue.
offeringConstrainerEnablerId
- the Id
of the
OfferingConstrainerEnabler
catalogueId
- the Id
of the Catalogue
AlreadyExistsException
-
offeringConstrainerEnablerId
already assigned to
catalogueId
NotFoundException
- offeringConstrainerEnablerId
or catalogueId
not foundNullArgumentException
-
offeringConstrainerEnablerId
or catalogueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignOfferingConstrainerEnablerFromCatalogue(Id offeringConstrainerEnablerId, Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainerEnabler
from a
Catalogue.
offeringConstrainerEnablerId
- the Id
of the
OfferingConstrainerEnabler
catalogueId
- the Id
of the Catalogue
NotFoundException
- offeringConstrainerEnablerId
or catalogueId
not found or
offeringConstrainerEnablerId
already assigned to
catalogueId
NullArgumentException
-
offeringConstrainerEnablerId
or catalogueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignOfferingConstrainerEnablerToCatalogue(Id offeringConstrainerEnablerId, Id fromCatalogueId, Id toCatalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OfferingConstrainerEnabler
from one
Catalogue
to another. Mappings to other Catalogues
are unaffected.offeringConstrainerEnablerId
- the Id
of the
OfferingConstrainerEnabler
fromCatalogueId
- the Id
of the current
Catalogue
toCatalogueId
- the Id
of the destination
Catalogue
NotFoundException
-
offeringConstrainerEnablerId, fromCatalogueId,
or
toCatalogueId
not found or
offeringConstrainerEnablerId,
not mapped to
fromCatalogueId
NullArgumentException
-
offeringConstrainerEnablerId, fromCatalogueId,
or
toCatalogueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.