public interface CatalogEnablerAdminSession extends OsidSession
This session creates and removes catalog enablers. The data for create
and update is provided via the CatalogEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasCatalogEnabler(Id catalogEnablerId,
Id aliasId)
Adds an
Id to a CatalogEnabler for the
purpose of creating compatibility. |
boolean |
canCreateCatalogEnabler()
Tests if this user can create catalog enablers.
|
boolean |
canCreateCatalogEnablerWithRecordTypes(Type[] catalogEnablerRecordTypes)
Tests if this user can create a single
CatalogEnabler
using the desired record types. |
boolean |
canDeleteCatalogEnablers()
Tests if this user can delete catalog enablers.
|
boolean |
canManageCatalogEnablerAliases()
Tests if this user can manage
Id aliases for catalog
enablers. |
boolean |
canUpdateCatalogEnablers()
Tests if this user can update catalog enablers.
|
CatalogEnabler |
createCatalogEnabler(CatalogEnablerForm catalogEnablerForm)
Creates a new
CatalogEnabler. |
void |
deleteCatalogEnabler(Id catalogEnablerId)
Deletes a
CatalogEnabler. |
Catalog |
getCatalog()
Gets the
Catalog associated with this session. |
CatalogEnablerForm |
getCatalogEnablerFormForCreate(Type[] catalogEnablerRecordTypes)
Gets the catalog enabler form for creating new catalog enablers.
|
CatalogEnablerForm |
getCatalogEnablerFormForUpdate(Id catalogEnablerId)
Gets the catalog enabler form for updating an existing catalog
enabler.
|
Id |
getCatalogId()
Gets the
Catalog Id associated with this
session. |
void |
updateCatalogEnabler(CatalogEnablerForm catalogEnablerForm)
Updates an existing catalog enabler.
|
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 canCreateCatalogEnabler()
CatalogEnabler
will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer create operations to an
unauthorized user. false
if CatalogEnabler
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateCatalogEnablerWithRecordTypes(Type[] catalogEnablerRecordTypes)
CatalogEnabler
using the desired record types. While
CatalogingRulesManager.getCatalogEnablerRecordTypes()
can be
used to examine which records are supported, this method tests which
record(s) are required for creating a specific CatalogEnabler.
Providing an empty array tests if a CatalogEnabler
can be created with no records.catalogEnablerRecordTypes
- array of catalog enabler record
types true
if CatalogEnabler
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
-
catalogEnablerRecordTypes
is null
mandatory
- This method must be implemented. CatalogEnablerForm getCatalogEnablerFormForCreate(Type[] catalogEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
catalogEnablerRecordTypes
- array of catalog enabler record
typesNullArgumentException
-
catalogEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. CatalogEnabler createCatalogEnabler(CatalogEnablerForm catalogEnablerForm) throws OperationFailedException, PermissionDeniedException
CatalogEnabler.
catalogEnablerForm
- the form for this CatalogEnabler
CatalogEnabler
IllegalStateException
- catalogEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- catalogEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- catalogEnablerForm
did not originate from
getCatalogEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateCatalogEnablers()
CatalogEnabler
will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer update operations to an
unauthorized user. false
if CatalogEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. CatalogEnablerForm getCatalogEnablerFormForUpdate(Id catalogEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
catalogEnablerId
- the Id
of the
CatalogEnabler
NotFoundException
- catalogEnablerId
is
not foundNullArgumentException
- catalogEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateCatalogEnabler(CatalogEnablerForm catalogEnablerForm) throws OperationFailedException, PermissionDeniedException
catalogEnablerForm
- the form containing the elements to be
updatedIllegalStateException
- catalogEnablerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- catalogEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- catalogEnablerForm
did not originate from
getCatalogEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteCatalogEnablers()
CatalogEnabler
will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer delete operations to an
unauthorized user. false
if CatalogEnabler
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteCatalogEnabler(Id catalogEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CatalogEnabler.
catalogEnablerId
- the Id
of the
CatalogEnabler
to removeNotFoundException
- catalogEnablerId
not
foundNullArgumentException
- catalogEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageCatalogEnablerAliases()
Id
aliases for catalog
enablers. A return of true does not guarantee successful
authorization. A return of false indicates that it is known changing
an alias will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer alias
operations to an unauthorized user. false
if CatalogEnabler
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasCatalogEnabler(Id catalogEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a CatalogEnabler
for the
purpose of creating compatibility. The primary Id
of
the CatalogEnabler
is determined by the provider. The
new Id
performs as an alias to the primary Id
. If the alias is a pointer to another catalog enabler. it is
reassigned to the given catalog enabler Id.
catalogEnablerId
- the Id
of a
CatalogEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- catalogEnablerId
not
foundNullArgumentException
- catalogEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.