/*
* Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Nuxeo - initial API and implementation
*
* $Id$
*/
package org.eclipse.ecr.core.schema.types;
import java.io.Serializable;
/**
* A field is a member of a complex type.
* <p>
* It is defined by a name and a type.
*
* @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
*/
public interface Field extends Serializable {
int NILLABLE = 1;
int CONSTANT = 2;
/**
* Gets the field name.
*
* @return the field name
*/
QName getName();
/**
* Gets the field type.
*
* @return the field type
*/
Type getType();
/**
* Gets the complex type that declared this field.
* <p>
* The declaring type may differ from the complex type owning this field.
* <p>
* For example, in the case of a derived complex type,
* the field is owned by both the derived type and the base type,
* but it's declared only by the base type.
*
* @return the complex that declared this field
*/
ComplexType getDeclaringType();
/**
* Gets this field default value or null if none.
*
* @return the default value if any was specified, null otherwise
*/
Object getDefaultValue();
/**
* Checks whether this field is nillable (can have null values).
*
* @return true if the field can have null values
*/
boolean isNillable();
/**
* Checks whether this field is constant (is read only).
*
* @return true if the field is constant false otherwise
*/
boolean isConstant();
/**
* Sets the default value of this field.
*
* @param value the value to set
*/
void setDefaultValue(String value);
/**
* Sets the nillable flag.
*
* @param isNillable
*/
void setNillable(boolean isNillable);
/**
* Sets the constant flag.
*
* @param isConstant
*/
void setConstant(boolean isConstant);
/**
* Gets the maximum number this field may occurs in the owner type.
* <p>
* By default this is 1. -1 is returned if not a maximum limit is imposed.
*
* @return the max occurrences
*/
int getMaxOccurs();
/**
* Gets the minimum number this field may occurs in the owner type.
* <p>
* By default this is 1.
*
* @return the min occurrences
*/
int getMinOccurs();
/**
* Sets max number of occurrences for this field.
*
* @param max max number of occurrences
*/
void setMaxOccurs(int max);
/**
* Sets min number of occurrences for this field.
*
* @param min min number of occurrences
*/
void setMinOccurs(int min);
/**
* Gets the maximum length for this field.
* <p>
* Value -1 means no constraint.
*
* @return the length
*/
int getMaxLength();
/**
* Sets the maximum length for this field.
*
* @param length the length, or -1 for no constraint
*/
void setMaxLength(int length);
}