|
Oracle® Information Rights Management Server Java API Reference 11g Release 1 (11.1.1) E12907-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ContextTemplateOperations
Context template operations. Template operations include template management methods, such as listing or creating templates. Also included are the operations that allow new Context
classifications to be created from those templates.
The methods on ContextTemplateOperations can be invoked using ContextTemplateOperationsInstance
.
Method Detail |
---|
Collection<ContextTemplate> listTemplates(Domain domain) throws UnknownDomainException, AuthorizationDeniedException
addDomainAdministrators
method. This method can be invoked by users that have the Domain Manager role in the related domain. This role can be assigned using the addDomainManagers
method.domain
- the domain.UnknownDomainException
- the domain does not exist.AuthorizationDeniedException
- authorization denied. The authenticated user is not authorized to call this operation.Collection<ContextTemplate> listTemplatesByStatus(Domain domain, ContextTemplate.Status status) throws UnknownDomainException
domain
- the domain.status
- the requested status.UnknownDomainException
- the domain does not exist.Collection<ContextTemplate> listActiveTemplates(Domain domain) throws UnknownDomainException, AuthorizationDeniedException
addDomainAdministrators
method. This method can be invoked by users that have the Domain Manager role in the related domain. This role can be assigned using the addDomainManagers
method.domain
- the domain.UnknownDomainException
- the domain does not exist.AuthorizationDeniedException
- authorization denied. The authenticated user is not authorized to call this operation.ContextTemplate saveNewContextTemplate(Domain domain, ContextTemplate template) throws ContextTemplateAlreadyExistsException, InvalidDocumentRoleException, UnknownDocumentRoleException, UnknownDomainException, IllegalArgumentException, AuthorizationDeniedException
Domain
.
addDomainAdministrators
method.
domain
- the domain.template
- the template.ContextTemplateAlreadyExistsException
- a context template already exists with the same Id within the specified domain.InvalidDocumentRoleException
- invalid role. One of the roles added to this template does not exist.UnknownDocumentRoleException
- unknown role. One of the roles associated with this template belongs to a different domain.UnknownDomainException
- the domain does not exist.IllegalArgumentException
- illegal argument. The template provided must NOT have it's Domain
property specified. This is to protect against passing in a template that has already been saved.AuthorizationDeniedException
- authorization denied. The authenticated user is not authorized to call this operation.ContextTemplate saveChangesToContextTemplate(ContextTemplate template, ContextTemplate delta) throws CannotRemoveDocumentRoleException, InvalidDocumentRoleException, UnknownDocumentRoleException, UnknownContextTemplateException, IllegalArgumentException, AuthorizationDeniedException
ContextTemplate
by providing two copies. Changes are made by comparing the two copies of the template. If there are no differences in a property then no changes are made to persistent storage for that property. Changes in collection based properties cause additions or removals to occur in persistent storage. For example, if the delta contains a new DocumentRole
as compared to the template then a new role will be associated with the template.Roles
will be immediately visible in any ContextInstance
linked to this template. If a role is removed from a template, any accounts assigned to the role will be automatically un-assigned (for contexts linked to this template).
addDomainAdministrators
method.
template
- the context template to compare to the delta.delta
- the changes. The Domain
and Uuid
properties must match with the template parameter.CannotRemoveDocumentRoleException
- the role cannot be removed from the template as it is in use. A document role cannot be remove if there are any contexts assignments using the role. The document role can only be removed from the template after the associated rights have been unassigned from all contexts based on the template.InvalidDocumentRoleException
- invalid role. One of the roles added to this template does not exist.UnknownDocumentRoleException
- unknown role. One of the roles associated with this template belongs to a different domain.UnknownContextTemplateException
- the context template does not exist.IllegalArgumentException
- illegal argument. If the Template
and Uuid
properties of the delta parameter do not match the template parameter. Also thrown if the the template provided does not have a Domain
property specified.AuthorizationDeniedException
- authorization denied. The authenticated user is not authorized to call this operation.void deleteContextTemplate(ContextTemplate template) throws CannotRemoveContextTemplateException
template
- the template.CannotRemoveContextTemplateException
- the template cannot be removed as it is in use. A context template cannot be deleted if there are any contexts linked to the template. The context template can only be deleted after the contexts are deleted.void deleteContextTemplates(Collection<ContextTemplate> templates) throws CannotRemoveContextTemplateException, AuthorizationDeniedException
addDomainAdministrators
method.
templates
- the set of template. This parameter is optional, it is valid to pass null or an empty collection.CannotRemoveContextTemplateException
- the template cannot be removed as it is in use. A context template cannot be deleted if there are any contexts linked to the template. The context template can only be deleted after the contexts are deleted.AuthorizationDeniedException
- authorization denied. The authenticated user is not authorized to call this operation.ContextTemplate refreshContextTemplate(ContextTemplate template) throws UnknownContextTemplateException, AuthorizationDeniedException
addDomainAdministrators
method. This method can be invoked by users that have the Domain Manager role in the related domain. This role can be assigned using the addDomainManagers
method.
template
- the template.UnknownContextTemplateException
- the context template does not exist.AuthorizationDeniedException
- authorization denied. The authenticated user is not authorized to call this operation.Collection<Label> getContextTemplateLabels(ContextInstance context) throws UnknownContextException, AuthorizationDeniedException
addContextManagers
method. This method can be invoked by users that have the Inspector role in the related context. This role can be assigned using the addInspectors
method.context
- the context.UnknownContextException
- the context does not exist.AuthorizationDeniedException
- authorization denied. The authenticated user is not authorized to call this operation.boolean contextTemplateExists(UUID uuid, Domain domain)
uuid
- the template UUID.domain
- the owning domain.ContextTemplate copyContextTemplate(Domain domain, ContextTemplate template) throws UnknownDomainException, UnknownContextTemplateException, IllegalArgumentException, AuthorizationDeniedException
Domain
. Copied templates are set with an inactive status. The template Labels
are also copied and altered to reflect that the result is a copy of the template. For example, in English, the template Standard would turn into Copy Of Standard.
addDomainAdministrators
method.
domain
- the domain.template
- the template.UnknownDomainException
- the domain does not exist.UnknownContextTemplateException
- the context template does not exist.IllegalArgumentException
- illegal argument. If the the template provided does not have it's Domain
property specified.AuthorizationDeniedException
- authorization denied. The authenticated user is not authorized to call this operation.
|
Oracle® Information Rights Management Server Java API Reference 11g Release 1 (11.1.1) E12907-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |