com.wewebu.ow.server.ecmimpl.opencmis.objectclass

Interface OwCMISObjectClass

All Superinterfaces:

com.wewebu.ow.server.ecm.OwObjectClass

All Known Subinterfaces:

OwCMISAlfrescoDocumentClass, OwCMISDocumentClass<D>, OwCMISDomainFolderClass, OwCMISFolderClass, OwCMISNativeObjectClass<T,O>, OwCMISPolicyClass, OwCMISRelationshipClass, OwCMISResourceObjectClass, OwCMISSessionObjectClass<S>

All Known Implementing Classes:

OwCMISAbstractAlfrescoClass, OwCMISAbstractAlfrescoObjectClass, OwCMISAbstractNativeObjectClass, OwCMISAbstractObjectClass, OwCMISAbstractSessionObjectClass, OwCMISAlfrescoDocumentObjectClassImpl, OwCMISAlfrescoDocumentTypeClassImpl, OwCMISAlfrescoFolderObjectClassImpl, OwCMISAlfrescoFolderTypeClassImpl, OwCMISAlfrescoPolicyTypeClassImpl, OwCMISAlfrescoRelationshipTypeClassImpl, OwCMISAlfrescoSkeletonObjectClass, OwCMISAlfrescoTypeClassImpl, OwCMISDocumentClassImpl, OwCMISDomainFolderClassImpl, OwCMISFolderClassImpl, OwCMISPolicyClassImpl, OwCMISRelationshipClassImpl, OwCMISResourceObjectClassImpl

public interface OwCMISObjectClass
extends com.wewebu.ow.server.ecm.OwObjectClass

Base interface for all CMIS object classes.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	MIME_TYPE_PREFIX_OW_POLICY
static String	MIME_TYPE_PREFIX_OW_RELATIONSHIP

Fields inherited from interface com.wewebu.ow.server.ecm.OwObjectClass

OPERATION_TYPE_CHECKIN, OPERATION_TYPE_CHECKOUT, OPERATION_TYPE_CREATE_NEW_OBJECT, OPERATION_TYPE_SET_PROPERTIES, OPERATION_TYPE_UNDEF

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canCreateNewObject()
String	createNewObject(boolean promote_p, Object mode_p, com.wewebu.ow.server.ecm.OwPropertyCollection properties_p, com.wewebu.ow.server.ecm.OwPermissionCollection permissions_p, com.wewebu.ow.server.ecm.OwContentCollection content_p, com.wewebu.ow.server.ecm.OwObject parent_p, String strMimeType_p, String strMimeParameter_p, boolean keepCheckedOut_p) Creates a new object with specific definition, will return the native ID of created object not a DMSID.
com.wewebu.ow.server.ecm.OwObjectSkeleton	createSkeletonObject(com.wewebu.ow.server.ecm.OwNetwork network_p, OwCMISResource res_p, OwCMISNativeSession session_p, com.wewebu.ow.server.util.OwXMLUtil initValues_p) Create skeleton Object for this specific object class.
OwCMISPropertyClass<?>	findPropertyClass(String className_p)
Map<String,OwCMISObjectClass>	getChildNames(com.wewebu.ow.server.ecm.OwNetwork network_p, boolean fExcludeHiddenAndNonInstantiable_p)
List<OwCMISObjectClass>	getChilds(com.wewebu.ow.server.ecm.OwNetwork network_p, boolean fExcludeHiddenAndNonInstantiable_p)
String	getCopyClassName() Return the class name which is unique and define fully the new type/class of a copy instance.
String	getMimetype()
String	getNamePropertyName()
OwCMISObjectClass	getParent()
OwCMISPreferredPropertyTypeCfg.PropertyType	getPreferredPropertyType(OwCMISPropertyClass<?> propertyClass)
OwCMISPropertyClass<?>	getPropertyClass(String strClassName_p)
Map<String,OwCMISPropertyClass<?>>	getPropertyClasses()
Collection<String>	getPropertyClassNames()
Set<OwCMISPropertyClass<?>>	getQueryablePropertyClasses()
String	getQueryName() Should return an non-null value if this object is query able.
OwCMISVirtualPropertyClass<?>	getVirtualPropertyClass(String strClassName_p)
Map<String,OwCMISVirtualPropertyClass<?>>	getVirtualPropertyClasses(boolean localOnly_p)
boolean	isAssignableFrom(OwCMISObjectClass class_p) A java class analogous method : Determines if the object-class represented by this object-class object is either the same as, or is a superclass of the object-class represented by the specified object-class parameter.
boolean	isContentRequired() Define if for this object the content is required.
boolean	isQueryable() As specified by the CMIS definition, the request method to verify if this object can be used in query FROM statement.
void	subclassedBy(OwCMISObjectClass subclass_p) Method called when this class is sub-classed.

Methods inherited from interface com.wewebu.ow.server.ecm.OwObjectClass

getClassName, getDescription, getDisplayName, getModes, getType, hasChilds, hasVersionSeries, isHidden

Field Detail

MIME_TYPE_PREFIX_OW_RELATIONSHIP

static final String MIME_TYPE_PREFIX_OW_RELATIONSHIP

See Also:

Constant Field Values

MIME_TYPE_PREFIX_OW_POLICY

static final String MIME_TYPE_PREFIX_OW_POLICY

See Also:

Constant Field Values

Method Detail

getMimetype

String getMimetype()

Returns:

the object class defined MIME type.

getVirtualPropertyClasses

Map<String,OwCMISVirtualPropertyClass<?>> getVirtualPropertyClasses(boolean localOnly_p)

getVirtualPropertyClass

OwCMISVirtualPropertyClass<?> getVirtualPropertyClass(String strClassName_p)

findPropertyClass

OwCMISPropertyClass<?> findPropertyClass(String className_p)

getPropertyClass

OwCMISPropertyClass<?> getPropertyClass(String strClassName_p)
                                        throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getPropertyClass in interface com.wewebu.ow.server.ecm.OwObjectClass

Throws:

com.wewebu.ow.server.exceptions.OwException

getPropertyClassNames

Collection<String> getPropertyClassNames()
                                         throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getPropertyClassNames in interface com.wewebu.ow.server.ecm.OwObjectClass

Throws:

com.wewebu.ow.server.exceptions.OwException

getPropertyClasses

Map<String,OwCMISPropertyClass<?>> getPropertyClasses()
                                                      throws com.wewebu.ow.server.exceptions.OwException

Returns:

a Map of property classes fully qualified names mapped to OwCMISPropertyClass for all properties defined by this object class (inherited properties included).

Throws:

com.wewebu.ow.server.exceptions.OwException

getChilds

List<OwCMISObjectClass> getChilds(com.wewebu.ow.server.ecm.OwNetwork network_p,
                                boolean fExcludeHiddenAndNonInstantiable_p)
                                  throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getChilds in interface com.wewebu.ow.server.ecm.OwObjectClass

Throws:

com.wewebu.ow.server.exceptions.OwException

getChildNames

Map<String,OwCMISObjectClass> getChildNames(com.wewebu.ow.server.ecm.OwNetwork network_p,
                                          boolean fExcludeHiddenAndNonInstantiable_p)
                                            throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getChildNames in interface com.wewebu.ow.server.ecm.OwObjectClass

Throws:

com.wewebu.ow.server.exceptions.OwException

getParent

OwCMISObjectClass getParent()

Specified by:

getParent in interface com.wewebu.ow.server.ecm.OwObjectClass

isContentRequired

boolean isContentRequired()
                          throws com.wewebu.ow.server.exceptions.OwException

Define if for this object the content is required.

Returns:

boolean true if is required, otherwise false

Throws:

com.wewebu.ow.server.exceptions.OwException

isQueryable

boolean isQueryable()

As specified by the CMIS definition, the request method to verify if this object can be used in query FROM statement.

Returns:

boolean query able

getQueryName

String getQueryName()

Should return an non-null value if this object is query able.

Returns:

String escaped query name, which MUST be used for searches

createNewObject

String createNewObject(boolean promote_p,
                     Object mode_p,
                     com.wewebu.ow.server.ecm.OwPropertyCollection properties_p,
                     com.wewebu.ow.server.ecm.OwPermissionCollection permissions_p,
                     com.wewebu.ow.server.ecm.OwContentCollection content_p,
                     com.wewebu.ow.server.ecm.OwObject parent_p,
                     String strMimeType_p,
                     String strMimeParameter_p,
                     boolean keepCheckedOut_p)
                       throws com.wewebu.ow.server.exceptions.OwException

Creates a new object with specific definition, will return the native ID of created object not a DMSID.

Parameters:

promote_p - boolean Major/Minor

mode_p - Object native mode (may not be supported and can be null)

properties_p - OwPropertyCollection defined properties for new object

permissions_p - OwPermissionCollection (if available, can be null)

content_p - OwContentCollection (can be null)

parent_p - OwObject (null if no parent needed)

strMimeType_p - String MIME type to be used

strMimeParameter_p - String MIME parameter

keepCheckedOut_p - boolean flag to create checked out

Returns:

a String ID for the newly created object (native ID)

Throws:

com.wewebu.ow.server.exceptions.OwException

getQueryablePropertyClasses

Set<OwCMISPropertyClass<?>> getQueryablePropertyClasses()
                                                        throws com.wewebu.ow.server.exceptions.OwException

Returns:

a Set of OwCMISPropertyClass for all queryable property classes that are defined by this object class

Throws:

com.wewebu.ow.server.exceptions.OwException

getNamePropertyName

String getNamePropertyName()
                           throws com.wewebu.ow.server.exceptions.OwException

Specified by:

getNamePropertyName in interface com.wewebu.ow.server.ecm.OwObjectClass

Throws:

com.wewebu.ow.server.exceptions.OwException

subclassedBy

void subclassedBy(OwCMISObjectClass subclass_p)
                  throws com.wewebu.ow.server.exceptions.OwInvalidOperationException

Method called when this class is sub-classed.

Parameters:

subclass_p - the new child of this class

Throws:

com.wewebu.ow.server.exceptions.OwInvalidOperationException - if the subclass constraints of this class are not met or the this class can not be sub-classed

isAssignableFrom

boolean isAssignableFrom(OwCMISObjectClass class_p)
                         throws com.wewebu.ow.server.exceptions.OwException

A java class analogous method : Determines if the object-class represented by this object-class object is either the same as, or is a superclass of the object-class represented by the specified object-class parameter.

Parameters:

class_p -

Returns:

the boolean value indicating whether objects of the type class can be interpreted as objects of this class

Throws:

com.wewebu.ow.server.exceptions.OwException

canCreateNewObject

boolean canCreateNewObject()
                           throws com.wewebu.ow.server.exceptions.OwException

Specified by:

canCreateNewObject in interface com.wewebu.ow.server.ecm.OwObjectClass

Throws:

com.wewebu.ow.server.exceptions.OwException

getPreferredPropertyType

OwCMISPreferredPropertyTypeCfg.PropertyType getPreferredPropertyType(OwCMISPropertyClass<?> propertyClass)
                                                                     throws com.wewebu.ow.server.exceptions.OwException

Throws:

com.wewebu.ow.server.exceptions.OwException

createSkeletonObject

com.wewebu.ow.server.ecm.OwObjectSkeleton createSkeletonObject(com.wewebu.ow.server.ecm.OwNetwork network_p,
                                                             OwCMISResource res_p,
                                                             OwCMISNativeSession session_p,
                                                             com.wewebu.ow.server.util.OwXMLUtil initValues_p)
                                                               throws Exception

Create skeleton Object for this specific object class.

Parameters:

network_p - OwNetwork which is currently requesting skeleton object

res_p - OwCMISResource for which skeleton is created

session_p - OwCMISNativeSession handling the current CMIS binding

initValues_p - OwXMLUtil which should be preset (can be null)

Returns:

OwObjectSkeleton

Throws:

Exception - if could not create skeleton object

getCopyClassName

String getCopyClassName()

Return the class name which is unique and define fully the new type/class of a copy instance.

Returns:

String full type definition, may return the same as OwObjectClass.getClassName()

Since:

4.1.1.1