com.wewebu.ow.server.ecm

Interface OwPropertyClass

All Superinterfaces:

OwFieldDefinition

All Known Implementing Classes:

OwFieldPropertyClassWrapper, OwFileObject.OwFilePropertyClass, OwResource.OwClassDescriptionPropertyClass, OwResource.OwObjectNamePropertyClass, OwResource.OwObjectPathPropertyClass, OwResource.OwResourcePropertyClass, OwResource.OwSpecialPropertyClass, OwResource.OwVersionSeriesPropertyClass, OwSearchPathField.OwSearchPathFieldClass, OwStandardClassSelectObject.OwStandardClassSelectObjectClass, OwStandardContentBasedRetrivalObject.OwStandardContentBasedRetrivalObjectClass, OwStandardHistoryEntry.OwStandardHistoryEntryPropertyClass, OwStandardPropertyClass, OwStandardSearchTemplate.OwOnTheFlySearchFieldDescription, OwVirtualLinkPropertyClasses.OwLinkFilterPropertyClass, OwVirtualLinkPropertyClasses.OwLinkRelationPropertyClass, OwVirtualLinkPropertyClasses.OwLinkSourcePropertyClass, OwVirtualLinkPropertyClasses.OwLinkTargetPropertyClass

public interface OwPropertyClass
extends OwFieldDefinition

Base interface for property class descriptions. Class descriptions are defined by the ECM System, the contain information about the property type.

To be implemented with the specific ECM system.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Property Summary

Properties

Type	Property and Description
boolean	isName check if property is identical the the OwObject.getName Property
boolean	isSystem check if property is a internal system property and contains no custom object information

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTEXT_MAX maximum context value for is...
static int	CONTEXT_NORMAL context for is...
static int	CONTEXT_ON_CHECKIN context for is...
static int	CONTEXT_ON_CREATE context for is...

Method Summary

Methods

Modifier and Type	Method and Description
String	getCategory() get the property category, or an empty string of no category is set
boolean	isHidden(int iContext_p) check if property is visible to the user
boolean	isNameProperty() check if property is identical the the OwObject.getName Property
boolean	isReadOnly(int iContext_p) check if property is read only on the class level.
boolean	isSystemProperty() check if property is a internal system property and contains no custom object information

Methods inherited from interface com.wewebu.ow.server.field.OwFieldDefinition

getClassName, getComplexChildClasses, getDefaultValue, getDescription, getDisplayName, getEnums, getFormat, getJavaClassName, getMaxValue, getMinValue, getNativeType, getNodeFromValue, getOperators, getValueFromNode, getValueFromString, isArray, isComplex, isEnum, isRequired

Property Detail

isSystem

check if property is a internal system property and contains no custom object information

Throws:

Exception

isName

check if property is identical the the OwObject.getName Property

Throws:

Exception

Field Detail

CONTEXT_NORMAL

static final int CONTEXT_NORMAL

context for is... functions

See Also:

Constant Field Values

CONTEXT_ON_CREATE

static final int CONTEXT_ON_CREATE

context for is... functions

See Also:

Constant Field Values

CONTEXT_ON_CHECKIN

static final int CONTEXT_ON_CHECKIN

context for is... functions

See Also:

Constant Field Values

CONTEXT_MAX

static final int CONTEXT_MAX

maximum context value for is... functions

See Also:

Constant Field Values

Method Detail

isSystemProperty

boolean isSystemProperty()
                         throws Exception

check if property is a internal system property and contains no custom object information

Throws:

Exception

isNameProperty

boolean isNameProperty()
                       throws Exception

check if property is identical the the OwObject.getName Property

Throws:

Exception

isReadOnly

boolean isReadOnly(int iContext_p)
                   throws Exception

check if property is read only on the class level. NOTE: isReadOnly is also defined in OwProperty on the instance level. I.e. A Property might be defined as readable on the class level, but still be write protected on a specific instance

Parameters:

iContext_p - Context in which the property is read-only as defined by CONTEXT_...

Returns:

true if property is read only

Throws:

Exception

isHidden

boolean isHidden(int iContext_p)
                 throws Exception

check if property is visible to the user

Parameters:

iContext_p - Context in which the property is read-only as defined by CONTEXT_...

Returns:

true if property is visible to the user

Throws:

Exception

getCategory

String getCategory()
                   throws Exception

get the property category, or an empty string of no category is set

Returns:

Category of Property

Throws:

Exception