# com.bea.content.manager
ObjectClassOps Interface

public interface ObjectClassOps
extends `Serializable`

This interface represents a service for ObjectClass CRUD operations. It is used to manage ObjectClasses as well as their PropertyDefinitions and PropertyChoices. Each ObjectClass may contain 0 to many PropertyDefinitions and each PropertyDefinition may contain 0 to many PropertyChoices.

Each repository has specific validation rules that the manager will delegate to. If a repository considers an attempted operation invalid, it will throw a RepositoryException. The rules for the manager are defined below.

All ObjectClasses, PropertyDefinitions and PropertyChoices are uniquely identified through their ID. The ID must contain both the repositoryName and the uid, unless the operation is a create then the uid should be null.

This interface does not support inheritance, or nested ObjectClasses. If the underlying repository does, then all super PropertyDefinitions will be retrieved with the specified ObjectClass.

Each operation may only occur against one repository at a time. Therefore, all IDs in a single operation must all have the same repository name.

For additional rules see com.bea.content.PropertyDefinition.

All Superinterfaces
  `Serializable`

## Method Summary

`public `ObjectClass`` | `createObjectClass`(`ObjectClass` objectClass) Creates the given ObjectClass and its PropertyDefinitions and PropertyChoices if applicable.
`public `PropertyDefinition`` | `createPropertyDefinition`(`ID` objectClassId, `PropertyDefinition` propertyDefinition) Adds the given propertyDefinition to the ObjectClass with the given objectClassId.
`public void` | `deleteObjectClass`(`ID` objectClassId) Deletes the ObjectClass with the given objectClassId.
`public void` | `deletePropertyDefinition`(`ID` propertyDefinitionId) Deletes the given propertyDefinition.
`public `ObjectClass`` | `getObjectClass`(`ID` objectClassId) Gets the ObjectClass with the given objectClassId.
`public `ObjectClass`[]` | `getObjectClasses`() Gets all of the ObjectClasses available for all content repositories the user is currently authenticated for.
`public `ObjectClass`[]` | `getObjectClasses`(`String` repositoryName) Gets all of the ObjectClasses available for a specific repository.
`public `InputStream`` | `getPropertyChoiceBytes`(`ID` propertyChoiceId) Gets the bytes for the given PropertyChoice.
`public `PropertyDefinition`` | `getPropertyDefinition`(`ID` propertyDefinitionId) Gets the PropertyDefinition for the given id.
`public `PropertyDefinition`[]` | `getPropertyDefinitions`(`ID` objectClassId) Gets all PropertyDefinitions for the given ObjectClass.
`public `ObjectClass`` | `renameObjectClass`(`ID` objectClassId, `String` newName) Renames the given ObjectClass.
`public `PropertyDefinition`` | `updatePropertyDefinition`(`PropertyDefinition` propertyDefinition) Updates the given propertyDefinition.

## Method Detail

### createObjectClass(ObjectClass) Method

    public ObjectClass createObjectClass(ObjectClass objectClass)
         throws AuthenticationException, AuthorizationException, ObjectClassExistsException, RepositoryException

Creates the given ObjectClass and its PropertyDefinitions and PropertyChoices if applicable.

#### Parameters

objectClass
  - the ObjectClass to create, along with any PropertyDefinitions to create also. The ObjectClass ID must contain the repositoryName.

#### Returns

ObjectClass - the new ObjectClass.

#### Exceptions

``AuthenticationException``
  - if the user attempting the operation isn't authenticated against the repository.
``AuthorizationException``
  - if the user attempting the operation is not authorized to perform it.
``ObjectClassExistsException``
  - if the name of the ObjectClass is already in use.
``RepositoryException``
  - if a validation error occurs.

### createPropertyDefinition(ID, PropertyDefinition) Method

    public PropertyDefinition createPropertyDefinition(ID objectClassId,
                                                       PropertyDefinition propertyDefinition)
         throws AuthenticationException, AuthorizationException, NoSuchObjectClassException, RepositoryException

Adds the given propertyDefinition to the ObjectClass with the given objectClassId. If isPrimary is true then this PropertyDefinition will be set to the primary PropertyDefinition for the ObjectClass. If there is already a primary PropertyDefinition, then it will be unset.

#### Parameters

objectClassId
  - the id of the ObjectClass to add the PropertyDefinition to. The ID must contain the repositoryName and the uid.

propertyDefinition
  - the propertyDefinition to create and add to the ObjectClass. The ID must contain the repositoryName and the uid. There can only be one primary PropertyDefinition that defines the primary content Property for a Node.

#### Returns

PropertyDefinition - the PropertyDefinition that was added to the ObjectClass.

#### Exceptions

``AuthenticationException``
  - if the user attempting the operation isn't authenticated against the repository.
``AuthorizationException``
  - if the user attempting the operation is not authorized to perform it.
``NoSuchObjectClassException``
  - if the objectClass does not exist.
``RepositoryException``
  - if a validation error occurs.

### deleteObjectClass(ID) Method

    public void deleteObjectClass(ID objectClassId)
         throws AuthenticationException, AuthorizationException, NoSuchObjectClassException, RepositoryException

Deletes the ObjectClass with the given objectClassId. All of the ObjectClass PropertyDefinitions, and their PropertyChocies are also deleted if present.

If the ObjectClass to delete has Nodes associated with it, either in the Repository or Virtual Repository it can't be removed.

#### Parameters

objectClassId
  - the ID of the ObjectClass to delete. The ID must contain the repositoryName and the uid.

#### Exceptions

``AuthenticationException``
  - if the user attempting the operation isn't authenticated against the repository.
``AuthorizationException``
  - if the user attempting the operation is not authorized to perform it.
``NoSuchObjectClassException``
  - if the ObjectClass to delete does not exist.
``RepositoryException``
  - if a validation error occurred.

### deletePropertyDefinition(ID) Method

    public void deletePropertyDefinition(ID propertyDefinitionId)
         throws AuthenticationException, AuthorizationException, NoSuchPropertyException, RepositoryException

Deletes the given propertyDefinition. If the PropertyDefinition to delete has Nodes associated with it's ObjectClass, either in the Repository or Virtual Repository it can't be removed.

#### Parameters

propertyDefinitionId
  - the ID of the propertyDefinition to delete. The PropertyDefinition ID must contain the repositoryName and the uid.

#### Exceptions

``AuthenticationException``
  - if the user attempting the operation isn't authenticated against the repository.
``AuthorizationException``
  - if the user attempting the operation is not authorized to perform it.
``NoSuchPropertyException``
``RepositoryException``
  - if a validation error occurs.

### getObjectClass(ID) Method

    public ObjectClass getObjectClass(ID objectClassId)
         throws AuthenticationException, AuthorizationException, NoSuchObjectClassException

Gets the ObjectClass with the given objectClassId.

#### Parameters

objectClassId
  - the ID of the ObjectClass to get. The ID must contain the repositoryName and the uid.

#### Returns

ObjectClass - the ObjectClass with the given id.

#### Exceptions

``AuthenticationException``
  - if the user attempting the operation isn't authenticated against the repository.
``AuthorizationException``
  - if the user attempting the operation is not authorized to perform it.
``NoSuchObjectClassException``
  - if the ObjectClass to get does not exist.

### getObjectClasses() Method

    public ObjectClass[] getObjectClasses()
         throws AuthenticationException, AuthorizationException, RepositoryException

Gets all of the ObjectClasses available for all content repositories the user is currently authenticated for.

#### Returns

ObjectClass[] - an array of all ObjectClasses - an empty array if none are currently defined.

#### Exceptions

``AuthenticationException``
  - if the user attempting the operation isn't authenticated against the repository.
``AuthorizationException``
  - if the user attempting the operation is not authorized to perform it.
``RepositoryException``
  - if a validation error occurred.

### getObjectClasses(String) Method

    public ObjectClass[] getObjectClasses(String repositoryName)
         throws AuthenticationException, AuthorizationException

Gets all of the ObjectClasses available for a specific repository.

#### Returns

ObjectClass[] - an array of all ObjectClasses, an empty array if none are currently defined.

#### Exceptions

``AuthenticationException``
  - if the user attempting the operation isn't authenticated against the repository.
``AuthorizationException``
  - if the user attempting the operation is not authorized to perform it.

### getPropertyChoiceBytes(ID) Method

    public InputStream getPropertyChoiceBytes(ID propertyChoiceId)
         throws AuthenticationException, AuthorizationException, NoSuchPropertyChoiceException

Gets the bytes for the given PropertyChoice.

After calling this method and retrieving the InputStream, you must close the InputStream when finished reading it.

WARNING: If using this interface to retrieve binary content from a BEA Repository, please read the javadoc for `RepositoryConfig```.

#### Parameters

propertyChoiceId
  - the ID of the propertyChoice to get the BinaryValue for. Must contain the repositoryName and the uid.

#### Returns

InputStream - the binary data for the Binary PropertyChoice.

#### Exceptions

``AuthenticationException``
  - if the user attempting the operation isn't authenticated against the repository.
``AuthorizationException``
  - if the user attempting the operation is not authorized to perform it.
``NoSuchPropertyChoiceException``
  - if the PropertyChoice does not exist.

### getPropertyDefinition(ID) Method

    public PropertyDefinition getPropertyDefinition(ID propertyDefinitionId)
         throws AuthenticationException, AuthorizationException, NoSuchPropertyDefinitionException

Gets the PropertyDefinition for the given id.

#### Parameters

propertyDefinitionId
  - the ID the PropertyDefinition to get. Must contain the repositoryName and the uid.

#### Returns

PropertyDefinition - the PropertyDefinition whose id matches propertyDefinitionId.

#### Exceptions

``AuthenticationException``
  - if the user attempting the operation isn't authenticated against the repository.
``AuthorizationException``
  - if the user attempting the operation is not authorized to perform it.
``NoSuchPropertyDefinitionException``
  - if the PropertyDefinition does not exist.

### getPropertyDefinitions(ID) Method

    public PropertyDefinition[] getPropertyDefinitions(ID objectClassId)
         throws AuthenticationException, AuthorizationException, NoSuchObjectClassException

Gets all PropertyDefinitions for the given ObjectClass.

#### Parameters

objectClassId
  - the ID for the ObjectClass to get its PropertyDefinitions. The ID must contain the repositoryName and the uid.

#### Returns

PropertyDefinition[] - the array of PropertyDefinitions for the given ObjectClass - of an empty array if none are currently defined.

#### Exceptions

``AuthenticationException``
  - if the user attempting the operation isn't authenticated against the repository.
``AuthorizationException``
  - if the user attempting the operation is not authorized to perform it.
``NoSuchObjectClassException``
  - if the ObjectClass does not exist.

### renameObjectClass(ID, String) Method

    public ObjectClass renameObjectClass(ID objectClassId,
                                         String newName)
         throws ObjectClassExistsException, NoSuchObjectClassException, RepositoryException

Renames the given ObjectClass.

#### Parameters

objectClassId
  - the ID of the objectClass to rename. The ID must contain the repositoryName and the uid.

newName
  - the new name of the ObjectClass

#### Returns

ObjectClass - the updated ObjectClass.

#### Exceptions

``ObjectClassExistsException``
  - if the name of the ObjectClass is already in use.
``NoSuchObjectClassException``
  - if the objectClass to rename doesn't exist.
``RepositoryException``
  - if a validation error occurs.

### updatePropertyDefinition(PropertyDefinition) Method

    public PropertyDefinition updatePropertyDefinition(PropertyDefinition propertyDefinition)
         throws AuthenticationException, AuthorizationException, NoSuchPropertyException, RepositoryException

Updates the given propertyDefinition.

The PropertyDefinition IDs and all of its PropertyChoices Ids should remain intact when updated. If PropertyChoices are no longer present on the PropertyDefinition, they should be deleted. If new PropertyChoices are present on the PropertyDefinition they should be added.

If isPrimary is true then this PropertyDefinition will be set to the primary PropertyDefinition for the ObjectClass. If there is already a primary PropertyDefinition, then it will be unset.

#### Parameters

propertyDefinition
  - the propertyDefinition to update. The PropertyDefinition ID must contain the repositoryName and the uid. There can only be one primary PropertyDefinition that defines the primary content Property for a Node.

#### Returns

PropertyDefinition - the updated PropertyDefinition.

#### Exceptions

``AuthenticationException``
  - if the user attempting the operation isn't authenticated against the repository.
``AuthorizationException``
  - if the user attempting the operation is not authorized to perform it.
``NoSuchPropertyException``
``RepositoryException``
  - if a validation error occurs.