atg.svc.repository.beans
Interface OrganizationValue

All Superinterfaces:

javax.ejb.EJBLocalObject, SecuredInternalItem

All Known Implementing Classes:

_OrganizationValue_BeanImpl, _OrganizationValue_Impl, _OrganizationValue_ReposImpl

public interface OrganizationValue
extends javax.ejb.EJBLocalObject, SecuredInternalItem

Class OrganizationValue

• Home: OrganizationValueHome
• Flags:
• Attributes:

  Attribute Name	Attribute Value
  atg.repository.query.SupportedQueries	and, comparison, constant, inFolders, includesAny, includes, includesItem, isNull, matchId, not, or, patternMatch, property, propertyOf, unconstrained, patternMatch, textSearch
  references	[:Solution.internalAudience, :Solution.internalAudienceSorted, :Solution.owningGroup]

Property Summaries

Property Name	Property Type	Property Description	Flags
id	String		R, W, Cch, Id, Qry, Req
internalAudience	String[]		R, W, Cch, Mv, Qry
internalAudienceSorted	Object[]		R, Cch, Drv, Mv, Qry
organizationId	String	original organization id	R, W, Cch, Qry, Req
organizationName	String	original organization name	R, W, Cch, Qry, Req
type	OrganizationValueType		R, W, Cch, Qry, Req

Flags Key:R=readable, W=writable, CsD=cascadeDelete, CsI=cascadeInsert, CsU=cascadeUpdate, Cch=cacheable, CoM=collectionOrMap, Drv=derived, Id=idProperty, Mv=multivalued, Qry=queryable, Req=required, Exp=expert, Hdn=hidden, Prf=preferred

Property Details

Property id: String

• Getter: getId()
• Setter: setId(java.lang.String)
• Flags: readable, writable, cacheable, idProperty, queryable, required
• Type Name: string
• Sort String: id

Property internalAudience: String[]

• Getter: getInternalAudience()
• Setter: setInternalAudience(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@e2892b
• Type Name: array
• Sort String: internalaudience
• Attributes:

  Attribute Name	Attribute Value
  deployable	false
  removeNullValues	true

Property internalAudienceSorted: Object[]

• Getter: getInternalAudienceSorted()
• Flags: readable, cacheable, derived, multivalued, queryable
• Type Name: array
• Sort String: internalaudiencesorted

Property organizationId: String

original organization id
• Getter: getOrganizationId()
• Setter: setOrganizationId(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: organizationid

Property organizationName: String

original organization name
• Getter: getOrganizationName()
• Setter: setOrganizationName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: organizationname

Property type: OrganizationValueType

• Getter: getType()
• Setter: setType(atg.svc.repository.beans.OrganizationValueType)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: enumerated
• Sort String: type
• Attributes:

  Attribute Name	Attribute Value
  useCodeForValue	false

Field Summary

Fields inherited from interface atg.svc.repository.beans.SecuredInternalItem

CLASS_VERSION

Method Summary

boolean	_isMutable() Returns true if the item is mutable.
void	copyTo(OrganizationValue destination) Copies the property values of this instance to another instance of the same data type.
java.lang.String	getDisplayName()
java.lang.String	getId() Getter for property id
java.lang.String[]	getInternalAudience() Getter for property internalAudience
java.lang.Object[]	getInternalAudienceSorted() Getter for property internalAudienceSorted
boolean	getIsVisible() Returns true if the object is visible for the current user.
java.lang.String	getOrganizationId() Getter for property organizationId
java.lang.String	getOrganizationName() Getter for property organizationName
OrganizationValueType	getType() Getter for property type
boolean	isRemoved() Returns true if the underlying object has been removed.
void	prepareInstanceForWrite() This must be called if the application intends to both read and write the instance in the same transaction, and it intends to do a read before doing a write.
void	setId(java.lang.String value) Setter for property id .
void	setInternalAudience(java.lang.String[] value) Setter for property internalAudience .
void	setOrganizationId(java.lang.String value) Setter for property organizationId .
void	setOrganizationName(java.lang.String value) Setter for property organizationName .
void	setType(OrganizationValueType value) Setter for property type .
void	writeInstance() This must be called after modifying an instance with a persistent implementation to guarantee that all changes are made persistent and visible to queries.

Methods inherited from interface javax.ejb.EJBLocalObject

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Method Detail

getId

java.lang.String getId()
                       throws javax.ejb.EJBException

Getter for property id

Returns:

String

Throws:

javax.ejb.EJBException

setId

void setId(java.lang.String value)
           throws javax.ejb.EJBException

Setter for property id . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getInternalAudience

java.lang.String[] getInternalAudience()
                                       throws javax.ejb.EJBException

Getter for property internalAudience

Specified by:

getInternalAudience in interface SecuredInternalItem

Returns:

String[]

Throws:

javax.ejb.EJBException

setInternalAudience

void setInternalAudience(java.lang.String[] value)
                         throws javax.ejb.EJBException

Setter for property internalAudience . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Specified by:

setInternalAudience in interface SecuredInternalItem

Parameters:

value - String[]

Throws:

javax.ejb.EJBException

getInternalAudienceSorted

java.lang.Object[] getInternalAudienceSorted()
                                             throws javax.ejb.EJBException

Getter for property internalAudienceSorted

Returns:

Object[]

Throws:

javax.ejb.EJBException

getOrganizationId

java.lang.String getOrganizationId()
                                   throws javax.ejb.EJBException

Getter for property organizationId

Returns:

String

Throws:

javax.ejb.EJBException

setOrganizationId

void setOrganizationId(java.lang.String value)
                       throws javax.ejb.EJBException

Setter for property organizationId . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getOrganizationName

java.lang.String getOrganizationName()
                                     throws javax.ejb.EJBException

Getter for property organizationName

Returns:

String

Throws:

javax.ejb.EJBException

setOrganizationName

void setOrganizationName(java.lang.String value)
                         throws javax.ejb.EJBException

Setter for property organizationName . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - String

Throws:

javax.ejb.EJBException

getType

OrganizationValueType getType()
                              throws javax.ejb.EJBException

Getter for property type

Returns:

OrganizationValueType

Throws:

javax.ejb.EJBException

setType

void setType(OrganizationValueType value)
             throws javax.ejb.EJBException

Setter for property type . The writeInstance() method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite() method may need to be called before making any changes.

Parameters:

value - OrganizationValueType

Throws:

javax.ejb.EJBException

isRemoved

boolean isRemoved()
                  throws javax.ejb.EJBException

Returns true if the underlying object has been removed. False otherwise.

Throws:

javax.ejb.EJBException

copyTo

void copyTo(OrganizationValue destination)
            throws javax.ejb.EJBException

Copies the property values of this instance to another instance of the same data type. Only properties that are both readable and writable are copied. Each property is copied by calling the getter method on the source instance and setting the result in the destination instance using the setter method.

Throws:

javax.ejb.EJBException

writeInstance

void writeInstance()
                   throws javax.ejb.EJBException

This must be called after modifying an instance with a persistent implementation to guarantee that all changes are made persistent and visible to queries. Changes might be made visible before calling this method, but this is not guaranteed until this method is called.

Throws:

javax.ejb.EJBException

prepareInstanceForWrite

void prepareInstanceForWrite()
                             throws javax.ejb.EJBException

This must be called if the application intends to both read and write the instance in the same transaction, and it intends to do a read before doing a write. This must be called before that first read.

Throws:

javax.ejb.EJBException

_isMutable

boolean _isMutable()

Returns true if the item is mutable. Items are only mutable after a setter method or prepareInstanceForWrite is called.

getDisplayName

java.lang.String getDisplayName()
                                throws javax.ejb.EJBException

Returns:

Returns the display name of the OrganizationValue.

Throws:

javax.ejb.EJBException - A system-level error occurred

getIsVisible

boolean getIsVisible()
                     throws javax.ejb.EJBException

Description copied from interface: SecuredInternalItem

Returns true if the object is visible for the current user.

Specified by:

getIsVisible in interface SecuredInternalItem

Returns:

Returns true if this value is visible for the current user.

Throws:

javax.ejb.EJBException - A system-level error occurred