atg.svc.repository.beans
Interface FieldDefinitionHome

All Superinterfaces:

javax.ejb.EJBLocalHome

All Known Implementing Classes:

_FieldDefinitionHome_BeanImpl, _FieldDefinitionHome_ReposImpl

public interface FieldDefinitionHome
extends javax.ejb.EJBLocalHome

Finder Summaries

Finder Name	Finder Description	Returns
findByPrimaryKey		one
findAll	Finds all Field Definitions	many
findAllCustom	Finds all custom Field Definitions	many
findAllCustomByName	Finds all custom Field Definitions ordered by logical name	many
findAllIntrinsic	Finds all intrinsic Field Definitions	many
findAllSystemEditable	Finds all custom Field Definitions	many
findAllUserEditable	Finds all user editable Field Definitions	many
findByName	Finds a FieldDefinition by name	one
findByNameAndIntrinsic	Finds a intrinsic FieldDefinition by name	one

Method Summary

FieldDefinition	create() Returns a new instance.
FieldDefinition	create(java.lang.String pId) Returns a new instance with the repository id set to the given id.
java.util.Collection	findAll() Finds all Field Definitions
java.util.Collection	findAllCustom() Finds all custom Field Definitions
java.util.Collection	findAllCustomByName() Finds all custom Field Definitions ordered by logical name
java.util.Collection	findAllIntrinsic() Finds all intrinsic Field Definitions
java.util.Collection	findAllSystemEditable() Finds all custom Field Definitions
java.util.Collection	findAllUserEditable() Finds all user editable Field Definitions
FieldDefinition	findByName(java.lang.String name) Finds a FieldDefinition by name
FieldDefinition	findByNameAndIntrinsic(java.lang.String name) Finds a intrinsic FieldDefinition by name
FieldDefinition	findByPrimaryKey(java.lang.String primaryKey) Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.
FieldDefinition	wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)
java.util.Collection	wrapRepositoryItems(java.util.Collection pRepositoryItems)

Methods inherited from interface javax.ejb.EJBLocalHome

remove

Method Detail

create

FieldDefinition create()
                       throws javax.ejb.CreateException,
                              javax.ejb.EJBException

Returns a new instance. The properties are set to default values, and may be changed by using the appropriate setter methods. The instance may be a repository or bean implementation depending on how this home's factory was obtained. If the instance is backed by a persistent implementation, it may not actually be persisted until FieldDefinition.writeInstance() is called on the instance (and the transaction is committed, if the implementation is transaction-aware).

Throws:

javax.ejb.CreateException

javax.ejb.EJBException

create

FieldDefinition create(java.lang.String pId)
                       throws javax.ejb.CreateException,
                              javax.ejb.EJBException

Returns a new instance with the repository id set to the given id. The properties are set to default values, and may be changed by using the appropriate setter methods. The instance may be a repository or bean implementation depending on how this home's factory was obtained. If the instance is backed by a persistent implementation, it may not actually be persisted until FieldDefinition.writeInstance() is called on the instance (and the transaction is committed, if the implementation is transaction-aware).

Throws:

javax.ejb.CreateException

javax.ejb.EJBException

findByPrimaryKey

FieldDefinition findByPrimaryKey(java.lang.String primaryKey)
                                 throws javax.ejb.FinderException,
                                        javax.ejb.EJBException

Returns the instance with the given primary key, throws ObjectNotFoundException if the instance is not found.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAll

java.util.Collection findAll()
                             throws javax.ejb.FinderException,
                                    javax.ejb.EJBException

Finds all Field Definitions

Returns:

a Collection of FieldDefinition instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAllCustom

java.util.Collection findAllCustom()
                                   throws javax.ejb.FinderException,
                                          javax.ejb.EJBException

Finds all custom Field Definitions

Returns:

a Collection of FieldDefinition instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAllCustomByName

java.util.Collection findAllCustomByName()
                                         throws javax.ejb.FinderException,
                                                javax.ejb.EJBException

Finds all custom Field Definitions ordered by logical name

Returns:

a Collection of FieldDefinition instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAllIntrinsic

java.util.Collection findAllIntrinsic()
                                      throws javax.ejb.FinderException,
                                             javax.ejb.EJBException

Finds all intrinsic Field Definitions

Returns:

a Collection of FieldDefinition instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAllSystemEditable

java.util.Collection findAllSystemEditable()
                                           throws javax.ejb.FinderException,
                                                  javax.ejb.EJBException

Finds all custom Field Definitions

Returns:

a Collection of FieldDefinition instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findAllUserEditable

java.util.Collection findAllUserEditable()
                                         throws javax.ejb.FinderException,
                                                javax.ejb.EJBException

Finds all user editable Field Definitions

Returns:

a Collection of FieldDefinition instances matching the criteria. The Collection.iterator() method can be used to retrieve the instances in order. If no instances match the criteria, then an empty Collection is returned. A null value is never returned.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findByName

FieldDefinition findByName(java.lang.String name)
                           throws javax.ejb.FinderException,
                                  javax.ejb.EJBException

Finds a FieldDefinition by name

Parameters:

name - Field definition name

Returns:

an instance matching the query criteria, or throws ObjectNotFoundException if no such instance is found.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

findByNameAndIntrinsic

FieldDefinition findByNameAndIntrinsic(java.lang.String name)
                                       throws javax.ejb.FinderException,
                                              javax.ejb.EJBException

Finds a intrinsic FieldDefinition by name

Parameters:

name - Field definition name

Returns:

an instance matching the query criteria, or throws ObjectNotFoundException if no such instance is found.

Throws:

javax.ejb.FinderException

javax.ejb.EJBException

wrapRepositoryItems

java.util.Collection wrapRepositoryItems(java.util.Collection pRepositoryItems)

wrapRepositoryItem

FieldDefinition wrapRepositoryItem(atg.repository.RepositoryItem pRepositoryItem)