public interface CatalogEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply CatalogEnablers
to Catalogs.
A Catalog
with multiple
CatalogEnablers
means any positive rule evaluation across the
enablers result in an enabled Catalog.
Modifier and Type | Method and Description |
---|---|
void |
assignCatalogEnablerToCatalog(Id catalogEnablerId,
Id catalogId)
Adds an existing
CatalogEnabler to a Catalog. |
boolean |
canAssignCatalogEnablers()
Tests if this user can alter catalog enabler/catalog mappings.
|
boolean |
canSequenceCatalogEnablers()
Tests if this user can order
CatalogEnablers. |
Catalog |
getCatalog()
Gets the
Catalog associated with this session. |
Id |
getCatalogId()
Gets the
Catalog Id associated with this
session. |
void |
moveCatalogEnablerAhead(Id catalogEnablerId,
Id catalogId,
Id referenceId)
Reorders catalog enablers for a catalog by moving the specified
catalog enabler in front of a reference catalog enabler.
|
void |
moveCatalogEnablerBehind(Id catalogEnablerId,
Id catalogId,
Id referenceId)
Reorders catalog enablers for a catalog by moving the specified
catalog enabler behind a reference catalog enabler.
|
void |
orderCatalogEnablers(Id[] catalogEnablerId,
Id catalogId)
Reorders a set of catalog enablers for a catalog.
|
void |
unassignCatalogEnablerFromCatalog(Id catalogEnablerId,
Id catalogId)
Removes a
CatalogEnabler from a Catalog. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogId()
Catalog
Id
associated with this
session. Catalog Id
associated with this sessionmandatory
- This method must be implemented. Catalog getCatalog() throws OperationFailedException, PermissionDeniedException
Catalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignCatalogEnablers()
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. void assignCatalogEnablerToCatalog(Id catalogEnablerId, Id catalogId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
CatalogEnabler
to a Catalog.
catalogEnablerId
- the Id
of the
CatalogEnabler
catalogId
- the Id
of the Catalog
AlreadyExistsException
- catalogEnablerId
is already applied to catalogId
NotFoundException
- catalogEnablerId
or
catalogId
not foundNullArgumentException
- catalogEnablerId
or catalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignCatalogEnablerFromCatalog(Id catalogEnablerId, Id catalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CatalogEnabler
from a Catalog.
catalogEnablerId
- the Id
of the
CatalogEnabler
catalogId
- the Id
of the Catalog
NotFoundException
- catalogEnablerId
or
catalogId
not found or catalogEnablerId
is not applied to catalogId
NullArgumentException
- catalogEnablerId
or catalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceCatalogEnablers()
CatalogEnablers.
A return
of true does not guarantee successful authorization. A return of false
indicates that it is known sequencing operations will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer sequencing operations to an
unauthorized user. false
if CatalogEnabler
ordering
is not authorized, true
otherwisemandatory
- This method must be implemented. void moveCatalogEnablerAhead(Id catalogEnablerId, Id catalogId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
catalogEnablerId
- the Id
of a
CatalogEnabler
catalogId
- the Id
of a Catalog
referenceId
- the reference catalog enabler Id
NotFoundException
- catalogEnablerId, catalogId,
or referenceId
not found or,
catalogEnablerId
or referenceId
not
related to catalogId
NullArgumentException
- catalogEnablerId,
catalogId
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveCatalogEnablerBehind(Id catalogEnablerId, Id catalogId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
catalogEnablerId
- the Id
of a
CatalogEnabler
catalogId
- the Id
of a Catalog
referenceId
- the reference catalog enabler Id
NotFoundException
- catalogEnablerId, catalogId,
or referenceId
not found or,
catalogEnablerId
or referenceId
not
related to catalogId
NullArgumentException
- catalogEnablerId,
catalogId
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderCatalogEnablers(Id[] catalogEnablerId, Id catalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
catalogEnablerId
- the Ids
for a set of
CatalogEnablers
catalogId
- the Id
of a Catalog
NotFoundException
- catalogId
not found
or, a catalogEnablerId
not related to
catalogId
NullArgumentException
- catalogEnablerIds
or catalogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.