Nuxeo ECM Projects 5.4.3-SNAPSHOT

org.nuxeo.ecm.core.schema.types
Interface Schema

All Superinterfaces:
ComplexType, Serializable, Type, ValueConverter
All Known Implementing Classes:
SchemaImpl

public interface Schema
extends ComplexType

A marker interface for schemas.

A schema is a complex type that can be used used to create composite types - such as document types.

Schemas have no super types and must not be used as field types.

Author:
Bogdan Stefanescu

Field Summary
 
Fields inherited from interface org.nuxeo.ecm.core.schema.types.Type
ANY
 
Method Summary
 TypeRef<Schema> getRef()
          Gets a proxy (or reference to this type).
 Type getType(String typeName)
          Gets a schema local type given its name.
 Type[] getTypes()
          Gets the types declared by this schema.
 boolean isLazy()
           
 void registerType(Type type)
          Registers a new type in that schema context.
 void setLazy(boolean isLazy)
          Sets the lazy flag for the given schema.
 
Methods inherited from interface org.nuxeo.ecm.core.schema.types.ComplexType
addField, addField, addField, addField, getField, getField, getFields, getFieldsCount, getNamespace, hasField, hasField, hasFields, isUnstructured
 
Methods inherited from interface org.nuxeo.ecm.core.schema.types.Type
decode, encode, getHelper, getName, getSchema, getSchemaName, getSuperType, getTypeHierarchy, isAnyType, isComplexType, isCompositeType, isListType, isNotNull, isReadOnly, isSimpleType, isSuperTypeOf, newInstance, validate
 
Methods inherited from interface org.nuxeo.ecm.core.schema.types.ValueConverter
convert
 

Method Detail

isLazy

boolean isLazy()

setLazy

void setLazy(boolean isLazy)
Sets the lazy flag for the given schema. DocumentTypes that was already initialized are not notified about schema change.

Parameters:
isLazy -

getRef

TypeRef<Schema> getRef()
Description copied from interface: Type
Gets a proxy (or reference to this type).

Specified by:
getRef in interface ComplexType
Specified by:
getRef in interface Type
Returns:
a reference to the type

getTypes

Type[] getTypes()
Gets the types declared by this schema.


getType

Type getType(String typeName)
Gets a schema local type given its name.

Parameters:
typeName -
Returns:
the type or null if no such type

registerType

void registerType(Type type)
Registers a new type in that schema context.

Parameters:
type -

Nuxeo ECM Projects 5.4.3-SNAPSHOT

Copyright © 2011 Nuxeo SAS. All Rights Reserved.