DocumentSecurityDirective

Name DocumentSecurityDirective
Usage DocumentSecurityHandlerService
getAuthorizedDocumentIds
Type Complex

Description

Defines a directive for processing a list of security attributes against a supplied list of documents. The names of
these security attributes represent the name of an {@link org.kuali.rice.kew.api.extension.ExtensionDefinition} which
will be used to load the appropriate {@link DocumentSecurityAttribute} implementation in order to perform the security filtering.

The actual directive is supplied to the appropriate application that is responsible for the given security attributes
by invoking that applications {@link DocumentSecurityHandlerService}. This class primarily functions as a form of
data transport in order to package and send the required information.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
documentSecurityAttributeNames Document Security Attribute Names StringList Returns the list of document security attribute names on this security directive. Will never return a null or
empty list.		 Required   Many No  
documents Documents DocumentList Returns the list of documents on this security directive. Will never return null, but may return an empty list. Required   Many No