atg.svc.repository.beans
Interface Segment

All Superinterfaces:

javax.ejb.EJBLocalObject, SecuredInternalItem

All Known Implementing Classes:

_Segment_BeanImpl, _Segment_Impl, _Segment_ReposImpl

public interface Segment
extends javax.ejb.EJBLocalObject, SecuredInternalItem

Class Segment

• Home: SegmentHome
• 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

Property Summaries

Property Name	Property Type	Property Description	Flags
field	boolean	true if the segment is for use on field security	R, W, Cch, Qry, Req
id	String		R, W, Cch, Id, Qry, Req
internal	boolean	true if the segment is in the internal profile repository else false	R, W, Cch, Qry, Req
internalAudience	String[]		R, W, Cch, Mv, Qry
internalAudienceSorted	Object[]		R, Cch, Drv, Mv, Qry
name	String	segment name from profile group name	R, W, Cch, Qry, Req
value	boolean	true if the segment is for use on value security	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 field: boolean

true if the segment is for use on field security
• Getter: isField()
• Setter: setField(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: boolean
• Sort String: field

Property id: String

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

Property internal: boolean

true if the segment is in the internal profile repository else false
• Getter: isInternal()
• Setter: setInternal(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: boolean
• Sort String: internal

Property internalAudience: String[]

• Getter: getInternalAudience()
• Setter: setInternalAudience(java.lang.String[])
• Flags: readable, writable, cacheable, multivalued, queryable
• Default Value: [Ljava.lang.String;@fb6c5f
• 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 name: String

segment name from profile group name
• Getter: getName()
• Setter: setName(java.lang.String)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: string
• Sort String: name

Property value: boolean

true if the segment is for use on value security
• Getter: isValue()
• Setter: setValue(boolean)
• Flags: readable, writable, cacheable, queryable, required
• Type Name: boolean
• Sort String: value

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(Segment destination) Copies the property values of this instance to another instance of the same data type.
atg.repository.RepositoryItemGroup	getGroup() Gets RepositoryItemGroup represented by this Segment
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	getName() Getter for property name
boolean	isField() Getter for property field
boolean	isInternal() Getter for property internal
boolean	isRemoved() Returns true if the underlying object has been removed.
boolean	isValue() Getter for property value
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	setField(boolean value) Setter for property field .
void	setId(java.lang.String value) Setter for property id .
void	setInternal(boolean value) Setter for property internal .
void	setInternalAudience(java.lang.String[] value) Setter for property internalAudience .
void	setName(java.lang.String value) Setter for property name .
void	setValue(boolean value) Setter for property value .
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

isField

boolean isField()
                throws javax.ejb.EJBException

Getter for property field

Returns:

boolean

Throws:

javax.ejb.EJBException

setField

void setField(boolean value)
              throws javax.ejb.EJBException

Setter for property field . 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 - boolean

Throws:

javax.ejb.EJBException

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

isInternal

boolean isInternal()
                   throws javax.ejb.EJBException

Getter for property internal

Returns:

boolean

Throws:

javax.ejb.EJBException

setInternal

void setInternal(boolean value)
                 throws javax.ejb.EJBException

Setter for property internal . 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 - boolean

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

getName

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

Getter for property name

Returns:

String

Throws:

javax.ejb.EJBException

setName

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

Setter for property name . 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

isValue

boolean isValue()
                throws javax.ejb.EJBException

Getter for property value

Returns:

boolean

Throws:

javax.ejb.EJBException

setValue

void setValue(boolean value)
              throws javax.ejb.EJBException

Setter for property value . 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 - boolean

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(Segment 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.

getGroup

atg.repository.RepositoryItemGroup getGroup()
                                            throws javax.ejb.EJBException

Gets RepositoryItemGroup represented by this Segment

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 segment is visible for the current user.

Throws:

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