com.filenet.api.constants

Class DefineSecurityParentage

java.lang.Object

com.filenet.api.constants.DefineSecurityParentage

All Implemented Interfaces:

java.io.Serializable

public class DefineSecurityParentage
extends java.lang.Object
implements java.io.Serializable

Exposes constants that indicate whether the SecurityFolder property of the object referenced by the ReferentialContainmentRelationship object's Head property is set to the Folder object referenced by the ReferentialContainmentRelationship object's Tail property. Use these constants when calling the Folder.file method to add a new object to a folder, or when calling createInstance to create a ReferentialContainmentRelationship object.

See Also:

Folder.file, Factory.ReferentialContainmentRelationship.createInstance, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static DefineSecurityParentage	DEFINE_SECURITY_PARENTAGE Specifies that security is to be inherited from the referenced parent (container).
static DefineSecurityParentage	DO_NOT_DEFINE_SECURITY_PARENTAGE Specifies that security is not to be inherited from the referenced parent (container).

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	getBooleanValue() Returns the Boolean value associated with a specific instance of this class.
static DefineSecurityParentage	getInstanceFromBoolean(boolean val) Gets an instance of this class from its associated boolean value.
boolean	getValue() Returns the boolean value associated with a specific instance of this class.
java.lang.String	toString() Returns a String representation of this DefineSecurityParentage instance.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFINE_SECURITY_PARENTAGE

public static final DefineSecurityParentage DEFINE_SECURITY_PARENTAGE

Specifies that security is to be inherited from the referenced parent (container).

DO_NOT_DEFINE_SECURITY_PARENTAGE

public static final DefineSecurityParentage DO_NOT_DEFINE_SECURITY_PARENTAGE

Specifies that security is not to be inherited from the referenced parent (container).

Method Detail

getValue

public boolean getValue()

Returns the boolean value associated with a specific instance of this class.

Returns:

A boolean representing a specific instance of this class.

getBooleanValue

public java.lang.Boolean getBooleanValue()

Returns the Boolean value associated with a specific instance of this class.

Returns:

A Boolean representing a specific instance of this class.

getInstanceFromBoolean

public static DefineSecurityParentage getInstanceFromBoolean(boolean val)

Gets an instance of this class from its associated boolean value.

Parameters:

val - A boolean representing the DefineSecurityParentage instance to retrieve. Valid values are DEFINE_SECURITY_PARENTAGE and DO_NOT_DEFINE_SECURITY_PARENTAGE; cannot be null.

Returns:

A DefineSecurityParentage object of the type requested.

Throws:

EngineRuntimeException - if the input parameter is invalid or null.

toString

public java.lang.String toString()

Returns a String representation of this DefineSecurityParentage instance.

Overrides:

toString in class java.lang.Object

Returns:

A String representing this DefineSecurityParentage.