Package wt.access.agreement

Class AuthorizationAgreement

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.enterprise._RevisionControlled
wt.enterprise.RevisionControlled
wt.access.agreement._AuthorizationAgreement
wt.access.agreement.AuthorizationAgreement
All Implemented Interfaces:
Externalizable, Serializable, wt.access._AccessControlled, wt.access._AccessControlList, wt.access._AdHocControlled, wt.access._IdentityAccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.AccessControlList, AdHocControlled, wt.access.agreement._AuthorizationAgreementTypeInterface, wt.access.agreement.AuthorizationAgreementTypeInterface, wt.access.IdentityAccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.change2._Changeable2, wt.change2._ChangeableIfc, Changeable2, ChangeableIfc, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, wt.folder._CabinetBased, wt.folder._Foldered, wt.folder._FolderEntry, wt.folder._FolderServiceManaged, wt.folder._IteratedFoldered, CabinetBased, Foldered, FolderEntry, wt.folder.FolderServiceManaged, wt.folder.history.Movable, IteratedFoldered, wt.iba.value._IBAHolder, wt.iba.value.IBAHolder, DisplayIdentification, wt.index._Indexable, Indexable, wt.inf.container._WTContained, WTContained, wt.lifecycle._IteratedLifeCycleManaged, _LifeCycleManaged, IteratedLifeCycleManaged, LifeCycleManaged, wt.locks._Lockable, Lockable, wt.maturity._Promotable, Promotable, wt.meeting.actionitem._IteratedSubjectOfActionItem, wt.meeting.actionitem._SubjectOfActionItem, wt.meeting.actionitem.IteratedSubjectOfActionItem, wt.meeting.actionitem.SubjectOfActionItem, wt.notify._Notifiable, Notifiable, wt.ownership._Ownable, wt.ownership.Ownable, wt.recent.RecentlyVisited, _TeamManaged, TeamManaged, wt.type._Typed, wt.type._TypeManaged, wt.type.FlexTyped, wt.type.Typed, wt.type.TypeManaged, _Iterated, wt.vc._Versionable, wt.vc._Versioned, wt.vc.baseline._Baselineable, Baselineable, Iterated, Versionable, Versioned, wt.vc.wip._Workable, Workable, wt.workflow.forum._IteratedSubjectOfForum, wt.workflow.forum._SubjectOfForum, wt.workflow.forum.IteratedSubjectOfForum, SubjectOfForum, wt.workflow.notebook._IteratedSubjectOfNotebook, wt.workflow.notebook._SubjectOfNotebook, wt.workflow.notebook.IteratedSubjectOfNotebook, wt.workflow.notebook.SubjectOfNotebook
@GenAsPersistable(superClass=RevisionControlled.class,interfaces={wt.type.Typed.class,WTContained.class,wt.access.IdentityAccessControlled.class,wt.folder.history.Movable.class,wt.access.agreement.AuthorizationAgreementTypeInterface.class},serializable=EXTERNALIZABLE_BASIC,versions={6049615454066909731L,9105782560890453755L},properties={@GeneratedProperty(name="description",type=java.lang.String.class,javaDoc="A string attribute representing a user-entered description for this authorization agreement. The description can be different for every iteration/version.",constraints=@PropertyConstraints(upperLimit=4000)),@GeneratedProperty(name="startDate",type=java.sql.Timestamp.class,javaDoc="This attribute represents the date and time at which this <code>AuthorizationAgreement</code> becomes active (as long as the life cycle state is in the approved state). An approved life cycle state, along with a current time between the start and end dates, defines whether an agreement is currently active. The start date can be different for every iteration/version.",constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="endDate",type=java.sql.Timestamp.class,javaDoc="This attribute represents the date and time at which this <code>AuthorizationAgreement</code> expires (as long as the life cycle state is in the approved state). An approved life cycle state, along with a current time between the start and end dates, defines whether an agreement is currently active. The end date can be different for every iteration/version.",constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="pendingExpirationInterval",type=int.class,initialValue="0",javaDoc="This attribute represents the number of days before an <code>AuthorizationAgreement</code> is set to expire that we emit the pending expiration event. The event will only be emitted for active <code>AuthorizationAgreement</code> iterations. The pending expiration interval can be different for every iteration/version.",constraints=@PropertyConstraints(lowerLimit=0,required=true)),@GeneratedProperty(name="authorizationLifecycleStates",type=java.io.Serializable.class,javaDoc="This attribute contains a list of life cycle states that apply to all AgreementAuthorizedObjects associatedwith this AuthorizationAgreement. The String representation of the life cycle state State object is stored, so thislist is actually an ArrayList<String>. If the ArrayList is null, ALL life cycle states is assumed. If the ArrayList is notnull, it must contain at least one life cycle state String value. This AuthorizationAgreement only grants access to itsAgreementAuthorizedObjects if they are in one of the life cycle states that are specified in this list.<p>In X-12 this field was originally declared ArrayList<State>, but State is not Evolvable so to avoid PDS errors thatoccur when trying to persist a non-Evolvable object in a small blob, the list had to be changed to ArrayList<String>;persisting String is also more efficient than State. Changing ArrayList<State> to ArrayList<String> doesn\'t cause a newEXTERNALIZATION_VERSION_UID to be generated, so the field had to be declared Serializable instead. We want the new UID so theBackground Blob Rewriter will recognize the class change and rewrite this field for existing AuthorizationAgreement objects.<p>Since all the code that uses the getter and setter for this field was written to expect ArrayList<State>, the getterstill returns ArrayList<State> and the setter still takes input ArrayList<State>.",columnProperties=@ColumnProperties(columnType=SMALL_BLOB),accessors=@PropertyAccessors(getAccess=PRIVATE,setAccess=PRIVATE)),@GeneratedProperty(name="authorizedRelatedChangeTypes",type=java.util.ArrayList.class,typeParameter="<java.lang.String>",javaDoc="This attribute contains a list of persisted type Strings associated with Related Change types to apply to this AuthorizationAgreement. If the list is null, NO Related Change objects will be authorized. If the list is not null, it must contain at least one persisted type String value. This AuthorizationAgreement extends access to Related Change objects that are both associated with an AgreementAuthorizedObject specified for this AuthorizationAgreement and that have persisted type Strings specified in this field.",columnProperties=@ColumnProperties(columnType=SMALL_BLOB)),@GeneratedProperty(name="securityLabelFilter",type=wt.access.agreement.SecurityLabelFilter.class,javaDoc="This attribute contains the agreement security label filter. The security label filter is used to specify which security label values the agreement can authorize. If this attribute is null, no security label filter is defined and the agreement authorizes the security label values as defined for the agreement type in the security labels configuration file.",columnProperties=@ColumnProperties(columnType=INLINE_BLOB),accessors=@PropertyAccessors(getAccess=PRIVATE,setAccess=PRIVATE))},foreignKeys={@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="master",type=AuthorizationAgreementMaster.class,cascade=false,constraints=@PropertyConstraints(required=true)),myRole=@MyRole(name="iteration",cascade=false)),@GeneratedForeignKey(name="AgreementDocumentLink",foreignKeyRole=@ForeignKeyRole(name="document",type=WTDocument.class,owner=false,javaDoc="The <code>WTDocument</code> iteration this link refers to"),myRole=@MyRole(name="agreement",cardinality=ONE_TO_MANY,javaDoc="The <code>AuthorizationAgreement</code> iteration this link refers to"))},derivedProperties={@DerivedProperty(name="name",derivedFrom="master>name"),@DerivedProperty(name="number",derivedFrom="master>number")},iconProperties=@IconProperties(standardIcon="netmarkets/images/agreement.gif",openIcon="netmarkets/images/agreement.gif")) public final class AuthorizationAgreement extends wt.access.agreement._AuthorizationAgreement
This object represents a particular iteration of an authorization agreement. It can be checked in and out, revised, and soft typed. Each particular iteration and version of an agreement may have a different description, start date, end date, and pending expiration interval. The wt.access.agreement package does not provide any supported API's to directly manage AuthorizationAgreement objects. AuthorizationAgreement is supported only to provide documentation. For more information, see the package-level Javadoc for wt.access.agreement.

Use the newAuthorizationAgreement static factory method(s), not the AuthorizationAgreement constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also: