SchemaInstance (JSDAI 4.2.0 2008-12-22T12:36:37)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jsdai.lang
Class SchemaInstance

java.lang.Object
  jsdai.lang.SdaiCommon
      jsdai.lang.SchemaInstance

All Implemented Interfaces:: QuerySource, SdaiEventSource

public abstract class SchemaInstance
extends jsdai.lang.SdaiCommon
implements SdaiEventSource, QuerySource

The SchemaInstance class represents a logical collection of SdaiModels.

Conceptionally, the SchemaInstance can be represented by the following EXPRESS entity:

ENTITY SchemaInstance;
  name : String;
  associatedModels : SET [0:?] OF SdaiModel;
  nativeSchema : ESchema_definition;
  repository : SdaiRepository;
  changeDate : OPTIONAL String;
  validationDate : String;
  validationResult : int;
  validationLevel : int;
  description : LIST [1:?] OF String;
  author       : LIST [1:?] OF String;
  organization       : LIST [1:?] OF String;
  preprocessorVersion : String;
  originatingSystem : String;
  authorization : String;
  defaultLanguage : OPTIONAL String;
  contextIdentifiers     : LIST [0:?] OF String;
UNIQUE
  UR1: name, repository;
WHERE
  WR1: SELF IN SELF.repository.schemas;
END_ENTITY;

All attributes are read-only, and for each of them a corresponding get method (or methods sometimes) is defined. Both the changeDate and validationDate can be retrieved either as String or as long. Similarly, nativeSchema can be retrieved either as ESchema_definition or as String. For preprocessorVersion, originatingSystem, authorization, and defaultLanguage the corresponding set methods are given.

A SchemaInstance belongs to an SdaiRepository and is available only when the SdaiRepository is open. Closing an SdaiRepository makes its SchemaInstances invalid. The associated SdaiModels can belong to different SdaiRepositories. The underlying EXPRESS schema of each SdaiModel associated with some SchemaInstance needs to be domain equivalent with the native schema of this SchemaInstance. The SchemaInstances define the domain over which to perform validation operations: for global rules, uniqueness rules, and instance references.

See Also:: "ISO 10303-22::8.4.1 schema_instance"

Method Summary
`void`	`addSchemaInstance(SchemaInstance schemaInstance)` Adds a new member to the set of schema instances that are included by this schema instance.
`void`	`addSdaiListener(SdaiListener listener)` Adds `SdaiListener` extending `java.util.EventListener` to a special aggregate in this repository.
`abstract void`	`addSdaiModel(SdaiModel model)` Adds a specified `SdaiModel` to the set of models that are associated with this schema instance.
`abstract SdaiPermission`	`checkPermission()` Returns this schema instance effective permission which determines the model's access rights.
`abstract void`	`checkRead()` Throws `SdaiException.SY_SEC` if the owning session has no read access to this schema instance.
`abstract void`	`checkWrite()` Throws `SdaiException.SY_SEC` if the owning session has no write access to this schema instance.
`abstract void`	`delete()` Deletes this `SchemaInstance`.
`void`	`exportClearTextEncoding(java.io.OutputStream location)` Creates a STEP file in a form of the exchange structure containing the data of this schema instance, that is, the header information and all its associated models.
`void`	`exportClearTextEncoding(java.io.OutputStream location, java.lang.String file_name)` Creates a STEP file in a form of the exchange structure containing the data of this schema instance, that is, the header information and all its associated models.
`void`	`exportClearTextEncoding(java.lang.String location)` Creates a STEP file in a form of the exchange structure containing the data of this schema instance, that is, the header information and all its associated models.
`void`	`exportClearTextEncoding(java.lang.String location, java.lang.String file_name)` Creates a STEP file in a form of the exchange structure containing the data of this schema instance, that is, the header information and all its associated models.
`void`	`exportXml(java.io.OutputStream location, InstanceReader instanceReader)` Writes this schema instance in XML representation to specified stream.
`abstract ASdaiModel`	`getAssociatedModels()` Returns the set of `SdaiModel`s associated with this schema instance.
`A_string`	`getAuthor()` Returns an aggregate of strings `A_string` identifying the person responsible for creating `SdaiModel`s associated with this schema instance.
`java.lang.String`	`getAuthorization()` Returns a `String` containing the name and mailing address of the person who authorizes the data contained in `SdaiModel`s associated with this schema instance.
`java.lang.String`	`getChangeDate()` Returns the date and time when this `SchemaInstance` was created or its aggregate "associated_models" most recently modified.
`long`	`getChangeDateLong()` Returns a `long` value of the date and time when this `SchemaInstance` was created or its aggregate "associated_models" most recently modified.
`A_string`	`getContextIdentifiers()` Returns an aggregate `A_string` containing information describing the contexts within which the instances in the `SdaiModel`s associated with this schema instance are applicable.
`java.lang.String`	`getDefaultLanguage()` Returns a `String` identifying the default language for string values in those `SdaiModel`s associated with this schema instance, for which their own default language is not specified.
`jsdai.dictionary.ESchema_definition`	`getDefiningSchema()` Returns definition of the Express schema represented by this schema instance.
`A_string`	`getDescription()` Returns an aggregate of strings `A_string` containing optional descriptions about the `SchemaInstance`.
`abstract ASchemaInstance`	`getIncludedSchemaInstances()` Returns the set of `SchemaInstance`s included by the current schema instance.
`java.lang.String`	`getLockingUser()` Returns the name of the user that has placed exclusive lock on remote schema instance.
`java.lang.String`	`getName()` Returns the name of the schema instance as a `String`.
`jsdai.dictionary.ESchema_definition`	`getNativeSchema()` Returns definition of the schema upon which this schema instance is based.
`java.lang.String`	`getNativeSchemaString()` Returns the name of the schema upon which this schema instance is based.
`A_string`	`getOrganization()` Returns an aggregate of strings `A_string` containing the organizations with whom the author of this schema instance is associated.
`java.lang.String`	`getOriginatingSystem()` Returns a `String` characterizing the system from which the data contained in `SdaiModel`s associated with this schema instance are originated.
`java.lang.String`	`getPreprocessorVersion()` Returns a `String` characterizing the system used to build `SdaiModel`s associated with this schema instance.
`ASdaiModel`	`getQuerySourceDomain()` Returns domain in which to perform a search.
`jsdai.query.SerializableRef`	`getQuerySourceDomainRef()`
`jsdai.query.SerializableRef`	`getQuerySourceInstanceRef()`
`AEntity`	`getQuerySourceInstances()` Returns starting instances which serve as the first input instance set for a query.
`ASdaiModel`	`getReferencedModels()` Returns the set of `SdaiModel`s associated either with this schema instance or a schema instance reached from this schema instance following the inclusion relation (directly or indirectly).
`SdaiRepository`	`getRepository()` Returns the `SdaiRepository` to which this schema instance belongs.
`java.lang.String`	`getValidationDate()` Returns the date of the most recent invocation of the `validateSchemaInstance` method for this schema instance.
`long`	`getValidationDateLong()` Returns a `long` value of the date of the most recent invocation of the `validateSchemaInstance` method for this schema instance.
`int`	`getValidationLevel()` Returns the level of expression evaluation for validation.
`int`	`getValidationResult()` Gives the result returned by the most recent invocation of the `validateSchemaInstance` method for this schema instance.
`boolean`	`isValidationCurrent()` This method is not implemented in current JSDAI version.
`int`	`query(java.lang.String where, EEntity entity, AEntity result)` This method is not implemented in current JSDAI version.
`void`	`removeSchemaInstance(SchemaInstance schemaInstance)` Removes a specified member from the set of schema instances that are included by this schema instance.
`void`	`removeSdaiListener(SdaiListener listener)` Removes `SdaiListener` extending `java.util.EventListener` from the special aggregate in this repository.
`void`	`removeSdaiModel(SdaiModel model)` Removes a specified `SdaiModel` from the set of models that are associated with this schema instance.
`void`	`rename(java.lang.String provided_name)` Assigns a new name to this `SchemaInstance`.
`void`	`setAuthorization(java.lang.String value)` Assigns a `String` value to the attribute characterizing the person who authorizes the data contained in `SdaiModel`s associated with this schema instance.
`void`	`setDefaultLanguage(java.lang.String value)` Assigns a `String` to the attribute identifying the default language for string values in those `SdaiModel`s associated with this schema instance, for which their own default language is not specified.
`void`	`setNativeSchema(java.lang.Class schema_def)` Puts definition of the Express schema upon which this schema instance will be based.
`void`	`setNativeSchema(jsdai.dictionary.ESchema_definition schema_def)` Puts definition of the schema upon which this schema instance will be based.
`void`	`setOriginatingSystem(java.lang.String value)` Assigns a `String` value to the attribute characterizing the system from which the data contained in `SdaiModel`s associated with this schema instance are originated.
`void`	`setPreprocessorVersion(java.lang.String value)` Assigns a `String` value to the attribute characterizing the system used to build `SdaiModel`s associated with this schema instance.
`boolean`	`testChangeDate()` Checks if the creation date or date of the most recent modification of the aggregate "associated_models" was set.
`java.lang.String`	`toString()` Returns a description of this schema instance as a `String`.
`int`	`validateGlobalRule(jsdai.dictionary.EGlobal_rule rule, jsdai.dictionary.AWhere_rule nonConf)` Determines if the submitted global rule is satisfied by the population associated with this `SchemaInstance`.
`int`	`validateGlobalRule(java.lang.String rule, jsdai.dictionary.AWhere_rule nonConf)` Determines if specified global rule is satisfied by the population associated with this `SchemaInstance`.
`int`	`validateInstanceReferenceDomain(AEntity nonConf)` This method is not implemented in current JSDAI version.
`int`	`validateSchemaInstance()` This method is not implemented in current JSDAI version.
`int`	`validateUniquenessRule(jsdai.dictionary.EUniqueness_rule rule, AEntity nonConf)` Determines whether the submitted uniqueness rule is satisfied by the population associated with this `SchemaInstance`.
`int`	`validateUniquenessRule(java.lang.String rule, AEntity nonConf)` Determines whether the submitted uniqueness rule is satisfied by the population associated with this `SchemaInstance`.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()
                         throws SdaiException

Returns the name of the schema instance as a String.

The schema instances within a SdaiRepository must have unique names.

Returns:: the name of this SchemaInstance.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - SY_ERR, underlying system error.

getDescription

public A_string getDescription()
                        throws SdaiException

Returns an aggregate of strings A_string containing optional descriptions about the SchemaInstance.

After invocation of importClearTextEncoding this aggregate within each SchemaInstance with which at least one SdaiModel in the resulting repository is associated contains strings taken from the field description of the entity file_description in the header of the exchange structure (see ISO 10303-21::8.2.1 file_description). During a read-write transaction the aggregate can be modified by adding/modifying/removing its members.

Returns:: aggregate containing informal description of this schema instance.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.
See Also:: "ISO 10303-21::8.2.1 file_description."

getAuthor

public A_string getAuthor()
                   throws SdaiException

Returns an aggregate of strings A_string identifying the person responsible for creating SdaiModels associated with this schema instance. The aggregate shall have its name at the first position and mail and/or email addresses at the following positions.

After invocation of importClearTextEncoding this aggregate within each SchemaInstance with which at least one SdaiModel in the resulting repository is associated contains strings taken from the field author of the entity file_name in the header of the exchange structure (see ISO 10303-21::8.2.2 file_name). During a read-write transaction the aggregate can be modified by adding/modifying/removing its members. It is a responsibility of the application to fill this aggregate with useful information.

Returns:: aggregate identifying an author of the SdaiModels associated with this schema instance.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.
See Also:: "ISO 10303-21::8.2.2 file_name."

getOrganization

public A_string getOrganization()
                         throws SdaiException

Returns an aggregate of strings A_string containing the organizations with whom the author of this schema instance is associated.

After invocation of importClearTextEncoding this aggregate within each SchemaInstance with which at least one SdaiModel in the resulting repository is associated contains strings taken from the field organization of the entity file_name in the header of the exchange structure (see ISO 10303-21::8.2.2 file_name). During a read-write transaction the aggregate can be modified by adding/modifying/removing its members. It is a responsibility of the application to fill this aggregate with useful information.

Returns:: aggregate that lists organizations an author of this schema instance is associated.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.
See Also:: "ISO 10303-21::8.2.2 file_name."

getPreprocessorVersion

public java.lang.String getPreprocessorVersion()
                                        throws SdaiException

Returns a String characterizing the system used to build SdaiModels associated with this schema instance.

After invocation of importClearTextEncoding this string within each SchemaInstance with which at least one SdaiModel in the resulting repository is associated has value taken from the field preprocessor_version of the entity file_name in the header of the exchange structure (see ISO 10303-21::8.2.2 file_name).

Returns:: string describing the system used to build SdaiModels associated with this schema instance.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.
See Also:: setPreprocessorVersion(java.lang.String), "ISO 10303-21::8.2.2 file_name."

setPreprocessorVersion

public void setPreprocessorVersion(java.lang.String value)
                            throws SdaiException

Assigns a String value to the attribute characterizing the system used to build SdaiModels associated with this schema instance. This assignment is allowed only if the repository containing this schema instance is open.

Parameters:: value - string describing the system used to build SdaiModels associated with this schema instance.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.; SdaiException - VA_NSET, value not set.
See Also:: getPreprocessorVersion(), "ISO 10303-21::8.2.2 file_name."

getOriginatingSystem

public java.lang.String getOriginatingSystem()
                                      throws SdaiException

Returns a String characterizing the system from which the data contained in SdaiModels associated with this schema instance are originated.

After invocation of importClearTextEncoding this string within each SchemaInstance with which at least one SdaiModel in the resulting repository is associated has value taken from the field originating_system of the entity file_name in the header of the exchange structure (see ISO 10303-21::8.2.2 file_name).

Returns:: string describing the system that is a source of the data in SdaiModels associated with this schema instance.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.
See Also:: setOriginatingSystem(java.lang.String), "ISO 10303-21::8.2.2 file_name."

setOriginatingSystem

public void setOriginatingSystem(java.lang.String value)
                          throws SdaiException

Assigns a String value to the attribute characterizing the system from which the data contained in SdaiModels associated with this schema instance are originated. This assignment is allowed only if the repository containing this schema instance is open.

Parameters:: value - string describing the system that is a source of the data in SdaiModels associated with this schema instance.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.; SdaiException - VA_NSET, value not set.
See Also:: getOriginatingSystem(), "ISO 10303-21::8.2.2 file_name."

getAuthorization

public java.lang.String getAuthorization()
                                  throws SdaiException

Returns a String containing the name and mailing address of the person who authorizes the data contained in SdaiModels associated with this schema instance.

After invocation of importClearTextEncoding this string within each SchemaInstance with which at least one SdaiModel in the resulting repository is associated has value taken from the field authorization of the entity file_name in the header of the exchange structure (see ISO 10303-21::8.2.2 file_name).

Returns:: string describing the person who authorizes this schema instance.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.
See Also:: setAuthorization(java.lang.String), "ISO 10303-21::8.2.2 file_name."

setAuthorization

public void setAuthorization(java.lang.String value)
                      throws SdaiException

Assigns a String value to the attribute characterizing the person who authorizes the data contained in SdaiModels associated with this schema instance. This assignment is allowed only if the repository containing this schema instance is open.

Parameters:: value - string describing the person who authorizes this schema instance.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.; SdaiException - VA_NSET, value not set.
See Also:: getAuthorization(), "ISO 10303-21::8.2.2 file_name."

getDefaultLanguage

public java.lang.String getDefaultLanguage()
                                    throws SdaiException

Returns a String identifying the default language for string values in those SdaiModels associated with this schema instance, for which their own default language is not specified. More precisely, for a model, the default language can be assigned individually. String returned by this method serves as a default language for those models for which an individual assignment was not made.

After invocation of importClearTextEncoding this string within each SchemaInstance with which at least one SdaiModel in the resulting repository is associated can take value extracted from the header of the exchange structure (see ISO 10303-21::8.2.4 section_language) provided an appropriate value is given there (otherwise it is set to null).

Returns:: String identifying the default language for string values in SdaiModels associated with this schema instance.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.
See Also:: setDefaultLanguage(java.lang.String), SdaiModel.getDefaultLanguage(), SdaiModel.setDefaultLanguage(java.lang.String), "ISO 10303-21::8.2.4 section_language."

setDefaultLanguage

public void setDefaultLanguage(java.lang.String value)
                        throws SdaiException

Assigns a String to the attribute identifying the default language for string values in those SdaiModels associated with this schema instance, for which their own default language is not specified. This assignment is allowed only if the repository containing this schema instance is open.

Parameters:: value - String identifying the default language for string values in SdaiModels associated with this schema instance.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.
See Also:: getDefaultLanguage(), SdaiModel.getDefaultLanguage(), SdaiModel.setDefaultLanguage(java.lang.String), "ISO 10303-21::8.2.4 section_language."

getContextIdentifiers

public A_string getContextIdentifiers()
                               throws SdaiException

Returns an aggregate A_string containing information describing the contexts within which the instances in the SdaiModels associated with this schema instance are applicable. Both the schema instance and each model associated with it have their own aggregates A_string for writing context identifiers. But for those models, for which their own aggregate is empty, contexts are described by the aggregate returned by this method, that is, by the schema instance aggregate.

After invocation of importClearTextEncoding this aggregate within each SchemaInstance with which at least one SdaiModel in the resulting repository is associated will contain information extracted from the header of the exchange structure (see ISO 10303-21::8.2.5 section_context) provided an appropriate information is given there. During a read-write transaction the aggregate can be modified by adding/modifying/removing its members.

Returns:: aggregate containing information describing the contexts.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.
See Also:: SdaiModel.getContextIdentifiers(), "ISO 10303-21::8.2.5 section_context."

checkPermission

public abstract SdaiPermission checkPermission()
                                        throws SdaiException

Returns this schema instance effective permission which determines the model's access rights.

Returns:: the effective permission
Throws:: SdaiException - if an error occurs performing underlying JSDAI operations
Since:: 4.0.1
See Also:: checkRead(), checkWrite(), SdaiPermission

checkRead

public abstract void checkRead()
                        throws SdaiException

Throws SdaiException.SY_SEC if the owning session has no read access to this schema instance. Otherwise this method returns with no action.

Throws:: SdaiException - SY_SEC if the owning session is not granted the read access; SdaiException - if an error occurs performing underlying JSDAI operations
Since:: 4.0.1
See Also:: checkPermission(), checkWrite(), SdaiPermission

checkWrite

public abstract void checkWrite()
                         throws SdaiException

Throws SdaiException.SY_SEC if the owning session has no write access to this schema instance. Otherwise this method returns with no action.

Throws:: SdaiException - SY_SEC if the owning session is not granted the write access; SdaiException - if an error occurs performing underlying JSDAI operations
Since:: 4.0.1
See Also:: checkPermission(), checkRead(), SdaiPermission

getAssociatedModels

public abstract ASdaiModel getAssociatedModels()
                                        throws SdaiException

Returns the set of SdaiModels associated with this schema instance. An SdaiModel may be associated with no, one or several schema instances.

Returns:: the set of models associated with this schema instance.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.

getNativeSchemaString

public java.lang.String getNativeSchemaString()
                                       throws SdaiException

Returns the name of the schema upon which this schema instance is based.

Returns:: the name of the native schema for this schema instance.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - SY_ERR, underlying system error.
See Also:: getNativeSchema(), setNativeSchema(ESchema_definition), setNativeSchema(Class)

getNativeSchema

public jsdai.dictionary.ESchema_definition getNativeSchema()
                                                    throws SdaiException

Returns definition of the schema upon which this schema instance is based.

Returns:: native schema definition for this schema instance.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - SY_ERR, underlying system error.
See Also:: getNativeSchemaString(), setNativeSchema(ESchema_definition), setNativeSchema(Class)

setNativeSchema

public void setNativeSchema(jsdai.dictionary.ESchema_definition schema_def)
                     throws SdaiException

Puts definition of the schema upon which this schema instance will be based. As a consequence of this operation, new change_date is set. Passing null value to the method's parameter results in SdaiException SD_NDEF.

Parameters:: schema_def - new native schema definition for this schema instance.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - SD_NDEF, schema definition not defined.
See Also:: getNativeSchema(), getNativeSchemaString(), setNativeSchema(Class)

setNativeSchema

public void setNativeSchema(java.lang.Class schema_def)
                     throws SdaiException

Puts definition of the Express schema upon which this schema instance will be based. As a consequence of this operation, new change_date is set. The value submitted to the parameter during invocation of the method shall be a special java class with the name constructed from the schema name. This class is contained in the package corresponding to the schema of interest. For example, if the schema name is "geometry_schema", then the package name is "jsdai.SGeometry_schema" and the value for the parameter shall be "jsdai.SGeometry_schema.SGeometry_schema.class". Passing null value to the method's parameter results in SdaiException SD_NDEF.

Parameters:: schema_def - Java class for the Express schema which has to be established as a native schema for this schema instance.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - SD_NDEF, schema definition not defined.
See Also:: getNativeSchema(), getNativeSchemaString(), setNativeSchema(ESchema_definition)

getRepository

public SdaiRepository getRepository()
                             throws SdaiException

Returns the SdaiRepository to which this schema instance belongs.

Returns:: the owning repository.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.

testChangeDate

public boolean testChangeDate()
                       throws SdaiException

Checks if the creation date or date of the most recent modification of the aggregate "associated_models" was set.

Returns:: true if the date was set, and false otherwise.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.
See Also:: getChangeDate(), getChangeDateLong()

getChangeDate

public java.lang.String getChangeDate()
                               throws SdaiException

Returns the date and time when this SchemaInstance was created or its aggregate "associated_models" most recently modified.

Returns:: a String representing the date and time.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - VA_NSET, value not set.
See Also:: testChangeDate(), getChangeDateLong()

getChangeDateLong

public long getChangeDateLong()
                       throws SdaiException

Returns a long value of the date and time when this SchemaInstance was created or its aggregate "associated_models" most recently modified.

Returns:: a long representing the date and time.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - VA_NSET, value not set.
See Also:: testChangeDate(), getChangeDate()

getValidationDate

public java.lang.String getValidationDate()
                                   throws SdaiException

Returns the date of the most recent invocation of the validateSchemaInstance method for this schema instance.

Returns:: a String representing the date and time.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - VA_NSET, value not set.
See Also:: getValidationDateLong(), validateSchemaInstance()

getValidationDateLong

public long getValidationDateLong()
                           throws SdaiException

Returns a long value of the date of the most recent invocation of the validateSchemaInstance method for this schema instance.

Returns:: a long representing the date and time.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - VA_NSET, value not set.
See Also:: getValidationDate(), validateSchemaInstance()

getValidationResult

public int getValidationResult()
                        throws SdaiException

Gives the result returned by the most recent invocation of the validateSchemaInstance method for this schema instance.

Returns:: an int value representing the result of validation.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.
See Also:: validateSchemaInstance()

getValidationLevel

public int getValidationLevel()
                       throws SdaiException

Returns the level of expression evaluation for validation.

Returns:: an int value representing the level of validation.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.
See Also:: validateSchemaInstance()

getDefiningSchema

public jsdai.dictionary.ESchema_definition getDefiningSchema()
                                                      throws SdaiException

Returns definition of the Express schema represented by this schema instance. Each Express schema having a directory in JSDAI library has its 'own' schema instance created during openSession. The name of the schema instance is the same as that of the related Express schema. The set associated_models of such a schema instance for an Express schema consists of all data dictionary models containing definition of at least one entity (or defined type) either defined, or declared(through USED or REFERENCED) or implicitly interfaced in this Express schema. All such schema instances belong to SystemRepository. If method is applied to schema instance of different kind, then SdaiException FN_NAVL is thrown.

Returns:: schema definition for the Express schema represented by this schema instance.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - FN_NAVL, function not available.; SdaiException - SY_ERR, underlying system error.

getLockingUser

public java.lang.String getLockingUser()
                                throws SdaiException

Returns the name of the user that has placed exclusive lock on remote schema instance. This method always returns null for local schema instance.

Returns:: the name of the user that has the exclusive lock or null if there is no exclusive lock on the schema instance
Throws:: SdaiException - if an error occurs during the operation or in underlying JSDAI operations
Since:: 4.1.0
See Also:: SdaiSession.lock(jsdai.lang.ASdaiRepository, jsdai.lang.ASchemaInstance, jsdai.lang.ASdaiModel, int)

delete

public abstract void delete()
                     throws SdaiException

Deletes this SchemaInstance.

Deleting of a SchemaInstance from "SystemRepository" is forbidden. In this case, SdaiException VT_NVLD is thrown.

Throws:: SdaiException - TR_NEXS, transaction does not exist.; SdaiException - TR_NRW, transaction not read-write.; SdaiException - TR_EAB, transaction ended abnormally.; SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - VT_NVLD, value type invalid.; SdaiException - RP_RO, read-only access to repository.; SdaiException - RP_LOCK, repository locked by another user.; SdaiException - SY_ERR, underlying system error.
See Also:: "ISO 10303-22::10.6.1 Delete schema instance"

rename

public void rename(java.lang.String provided_name)
            throws SdaiException

Assigns a new name to this SchemaInstance. This new name must differ from the names of other schema instances in the same SdaiRepository. If this condition is violated, then SdaiException SI_DUP is thrown. Passing null value to the method's parameter results in SdaiException VA_NSET.

Renaming of a SchemaInstance from "SystemRepository" is forbidden. In the case of such an attempt, SdaiException VT_NVLD is thrown.

Parameters:: provided_name - new name of this schema instance.
Throws:: SdaiException - TR_NEXS, transaction does not exist.; SdaiException - TR_NRW, transaction not read-write.; SdaiException - TR_EAB, transaction ended abnormally.; SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - SI_DUP, schema instance duplicate.; SdaiException - VT_NVLD, value type invalid.; SdaiException - VA_NSET, value not set.; SdaiException - RP_RO, read-only access to repository.; SdaiException - RP_LOCK, repository locked by another user.; SdaiException - SY_ERR, underlying system error.
See Also:: "ISO 10303-22::10.6.2 Rename schema instance"

addSdaiModel

public abstract void addSdaiModel(SdaiModel model)
                           throws SdaiException

Adds a specified SdaiModel to the set of models that are associated with this schema instance. If null value is passed to the method's parameter, then SdaiException VA_NSET is thrown.

Adding a model to a SchemaInstance in "SystemRepository" is forbidden. In the case of such an attempt, SdaiException VT_NVLD is thrown.

Parameters:: model - the SdaiModel submitted to associate with this schema instance.
Throws:: SdaiException - TR_NEXS, transaction does not exist.; SdaiException - TR_NRW, transaction not read-write.; SdaiException - TR_EAB, transaction ended abnormally.; SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - VT_NVLD, value type invalid.; SdaiException - VA_NSET, value not set.; SdaiException - RP_RO, read-only access to repository.; SdaiException - RP_LOCK, repository locked by another user.; SdaiException - SY_ERR, underlying system error.
See Also:: "ISO 10303-22::10.6.3 Add SDAI-model"

removeSdaiModel

public void removeSdaiModel(SdaiModel model)
                     throws SdaiException

Removes a specified SdaiModel from the set of models that are associated with this schema instance. If null value is passed to the method's parameter, then SdaiException VA_NSET is thrown.

Removing a model from a SchemaInstance in "SystemRepository" is forbidden. In the case of such an attempt, SdaiException VT_NVLD is thrown.

Parameters:: model - the SdaiModel that is to be removed from the set "associated_models" of this schema instance.
Throws:: SdaiException - TR_NEXS, transaction does not exist.; SdaiException - TR_NRW, transaction not read-write.; SdaiException - TR_EAB, transaction ended abnormally.; SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - VT_NVLD, value type invalid.; SdaiException - VA_NSET, value not set.; SdaiException - RP_RO, read-only access to repository.; SdaiException - RP_LOCK, repository locked by another user.; SdaiException - SY_ERR, underlying system error.
See Also:: "ISO 10303-22::10.6.4 Remove SDAI-model"

addSdaiListener

public void addSdaiListener(SdaiListener listener)

Adds SdaiListener extending java.util.EventListener to a special aggregate in this repository.

Specified by:: addSdaiListener in interface SdaiEventSource

Parameters:: listener - a SdaiListener to be added.
Since:: 4.1.0
See Also:: removeSdaiListener(jsdai.lang.SdaiListener)

removeSdaiListener

public void removeSdaiListener(SdaiListener listener)

Removes SdaiListener extending java.util.EventListener from the special aggregate in this repository.

Specified by:: removeSdaiListener in interface SdaiEventSource

Parameters:: listener - SdaiListener to be removed.
Since:: 4.1.0
See Also:: addSdaiListener(jsdai.lang.SdaiListener)

query

public int query(java.lang.String where,
                 EEntity entity,
                 AEntity result)
          throws SdaiException

This method is not implemented in current JSDAI version.

SdaiException FN_NAVL will be thrown if this method is invoked.

Specified by:: query in interface QuerySource

Parameters:: where - a String value; entity - an EEntity value; result - an AEntity value
Returns:: an int value
Throws:: SdaiException - FN_NAVL, function not available.
See Also:: "ISO 10303-22::10.4.14 SDAI query"

getQuerySourceDomain

public ASdaiModel getQuerySourceDomain()
                                throws SdaiException

Description copied from interface: QuerySource

Returns domain in which to perform a search.

Specified by:: getQuerySourceDomain in interface QuerySource

Returns:: ASdaiModel containing the domain
Throws:: SdaiException - if an error occurs during the operation or in underlying JSDAI operations

getQuerySourceInstances

public AEntity getQuerySourceInstances()
                                throws SdaiException

Description copied from interface: QuerySource

Returns starting instances which serve as the first input instance set for a query.

Specified by:: getQuerySourceInstances in interface QuerySource

Returns:: AEntity containing the instances or null this aggregate consists all instances in query source domain
Throws:: SdaiException - if an error occurs during the operation or in underlying JSDAI operations

getQuerySourceInstanceRef

public jsdai.query.SerializableRef getQuerySourceInstanceRef()
                                                      throws SdaiException

Specified by:: getQuerySourceInstanceRef in interface QuerySource

Throws:: SdaiException
Since:: 3.6.0

getQuerySourceDomainRef

public jsdai.query.SerializableRef getQuerySourceDomainRef()
                                                    throws SdaiException

Specified by:: getQuerySourceDomainRef in interface QuerySource

Throws:: SdaiException
Since:: 3.6.0

validateGlobalRule

public int validateGlobalRule(jsdai.dictionary.EGlobal_rule rule,
                              jsdai.dictionary.AWhere_rule nonConf)
                       throws SdaiException

Determines if the submitted global rule is satisfied by the population associated with this SchemaInstance. Validation is performed for all entity instances of the entity types to which the specified global rule applies in all SdaiModels associated with the schema instance.

Parameters:: rule - the global rule to validate; nonConf - the non-persistent list to which those instances of the entity where_rule within the validated global rule to which they did not conform are appended (if the return value is 1)
Returns:: number 2 if global rule is satisfied, number 1 if it is violated, and number 3 if evaluation value is indeterminate.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RU_NDEF, rule not defined.; SdaiException - AI_NEXS, aggregate instance does not exist.; SdaiException - RP_NOPN, repository is not open.; SdaiException - TR_NEXS, transaction does not exist.; SdaiException - FN_NAVL, function not available.; SdaiException - SY_ERR, underlying system error.
See Also:: validateGlobalRule(String rule, AWhere_rule nonConf), "ISO 10303-22::10.6.5 Validate global rule"

validateGlobalRule

public int validateGlobalRule(java.lang.String rule,
                              jsdai.dictionary.AWhere_rule nonConf)
                       throws SdaiException

Determines if specified global rule is satisfied by the population associated with this SchemaInstance. Validation is performed for all entity instances of the entity types to which the specified global rule applies in all SdaiModels associated with the schema instance.

Parameters:: rule - the name of the global rule to validate; nonConf - the non-persistent list to which those instances of the entity where_rule within the validated global rule to which they did not conform are appended (if the return value is 1)
Returns:: number 2 if global rule is satisfied, number 1 if it is violated, and number 3 if evaluation value is indeterminate.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RU_NDEF, rule not defined.; SdaiException - AI_NEXS, aggregate instance does not exist.; SdaiException - RP_NOPN, repository is not open.; SdaiException - TR_NEXS, transaction does not exist.; SdaiException - FN_NAVL, function not available.; SdaiException - SY_ERR, underlying system error.
See Also:: validateGlobalRule(EGlobal_rule rule, AWhere_rule nonConf), "ISO 10303-22::10.6.5 Validate global rule"

validateUniquenessRule

public int validateUniquenessRule(jsdai.dictionary.EUniqueness_rule rule,
                                  AEntity nonConf)
                           throws SdaiException

Parameters:: rule - the uniqueness rule to validate; nonConf - the non-persistent list to which instances not conforming to validation are appended (if the return value is 1)
Returns:: number 2 if uniqueness rule is satisfied, number 1 if it is violated, and number 3 if evaluation value is indeterminate.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RU_NDEF, rule not defined.; SdaiException - AI_NEXS, aggregate instance does not exist.; SdaiException - RP_NOPN, repository is not open.; SdaiException - TR_NEXS, transaction does not exist.; SdaiException - FN_NAVL, function not available.; SdaiException - SY_ERR, underlying system error.
See Also:: validateUniquenessRule(String rule, AEntity nonConf), "ISO 10303-22::10.6.6 Validate uniqueness rule"

validateUniquenessRule

public int validateUniquenessRule(java.lang.String rule,
                                  AEntity nonConf)
                           throws SdaiException

Determines whether the submitted uniqueness rule is satisfied by the population associated with this SchemaInstance. Validation is performed for all entity instances of the entity type in which the uniqueness rule was defined in all SdaiModels associated with the schema instance. The rule is specified by the string of the form "entity_name.rule_name", where 'entity_name' is the name of the entity data type within which the rule is declared and 'rule_name' is the name (if present) of the rule. If the rule has no name, then the supplied string shall be of the form "entity_name." or just "entity_name".

Parameters:: rule - the name of the uniqueness rule to validate qualified by the name of its owning entity data type; nonConf - the non-persistent list to which instances not conforming to validation are appended (if the return value is 1)
Returns:: number 2 if uniqueness rule is satisfied, number 1 if it is violated, and number 3 if evaluation value is indeterminate.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RU_NDEF, rule not defined.; SdaiException - AI_NEXS, aggregate instance does not exist.; SdaiException - RP_NOPN, repository is not open.; SdaiException - TR_NEXS, transaction does not exist.; SdaiException - FN_NAVL, function not available.; SdaiException - SY_ERR, underlying system error.
See Also:: validateUniquenessRule(EUniqueness_rule rule, AEntity nonConf), "ISO 10303-22::10.6.6 Validate uniqueness rule"

validateInstanceReferenceDomain

public int validateInstanceReferenceDomain(AEntity nonConf)
                                    throws SdaiException

This method is not implemented in current JSDAI version.

SdaiException FN_NAVL will be thrown if this method is invoked.

Throws:: SdaiException - FN_NAVL, function not available.
See Also:: "ISO 10303-22::10.6.7 Validate instance reference domain"

validateSchemaInstance

public int validateSchemaInstance()
                           throws SdaiException

This method is not implemented in current JSDAI version.

SdaiException FN_NAVL will be thrown if this method is invoked.

Throws:: SdaiException - FN_NAVL, function not available.
See Also:: "ISO 10303-22::10.6.8 Validate schema instance"

isValidationCurrent

public boolean isValidationCurrent()
                            throws SdaiException

This method is not implemented in current JSDAI version.

SdaiException FN_NAVL will be thrown if this method is invoked.

Throws:: SdaiException - FN_NAVL, function not available.
See Also:: "ISO 10303-22::10.6.9 Is validation current"

toString

public java.lang.String toString()

Returns a description of this schema instance as a String. It includes constant string "SchemaInstance: " and the name of the schema instance.

Returns:: a description of the schema instance.

exportClearTextEncoding

public void exportClearTextEncoding(java.lang.String location)
                             throws SdaiException

Creates a STEP file in a form of the exchange structure containing the data of this schema instance, that is, the header information and all its associated models. This operation is allowed only if this schema instance was not modified and no associated model was created, deleted or modified since the most recent commit or abort operation was performed. If this condition is not satisfied, then SdaiException TR_RW is thrown. At the moment of invocation of the method the repository owning this schema instance must be opened. If parameter location gets some String value, then this value is used as a name for the resulting file. If, however, location is null, then the file name is constructed by taking the name of this schema instance and combining it with the extension "stp". The contents of each associated model is written down to the file as a separate data section. The header of the file includes time-stamp which specifies the date and time when the schema instance was created or most recently modified. The attribute name of the entity file_name in the header of the exchange structure (see ISO 10303-21::8.2.2 file_name) is set to the name of this schema instance. The value of the attribute implementation_level of the entity file_description (see ISO 10303-21::8.2.1 file_description) can take one of the following values:

"2;1" if the aggregate associated_models contains at most one model;
"3;1" otherwise; in this case for the schema instance an instance of the entity file_population in the header of the exchange structure (see ISO 10303-21::8.2.4 file_population) is created;

In this file_population instance the value standing for associated_models is missing, that is, dollar sign is used. This happens because all the data sections in the resulting exchange structure file correspond to models in the associated_models set (see ISO 10303-21::8.2.4 file_population).

After execution of this method the schema instance itself remains unchanged. The method is disabled for the special schema instance data_dictionary defined in SdaiSession class. In this case SdaiException FN_NAVL is thrown.

Parameters:: location - the name of the file created by the method.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.; SdaiException - TR_NEXS, transaction does not exist.; SdaiException - TR_NAVL, transaction currently not available.; SdaiException - FN_NAVL, function not available.; SdaiException - SY_ERR, underlying system error.
Since:: 4.0.0
See Also:: SdaiRepository.exportClearTextEncoding(java.lang.String), exportClearTextEncoding(String location, String file_name), exportClearTextEncoding(OutputStream location), see "ISO 10303-21"

exportClearTextEncoding

public void exportClearTextEncoding(java.lang.String location,
                                    java.lang.String file_name)
                             throws SdaiException

Creates a STEP file in a form of the exchange structure containing the data of this schema instance, that is, the header information and all its associated models. This operation is allowed only if this schema instance was not modified and no associated model was created, deleted or modified since the most recent commit or abort operation was performed. If this condition is not satisfied, then SdaiException TR_RW is thrown. At the moment of invocation of the method the repository owning this schema instance must be opened. If parameter location gets some String value, then this value is used as a name for the resulting file. If, however, location is null, then the file name is constructed by taking the name of this schema instance and combining it with the extension "stp". The contents of each associated model is written down to the file as a separate data section. The header of the file includes time-stamp which specifies the date and time when the schema instance was created or most recently modified. The attribute name of the entity file_name in the header of the exchange structure (see ISO 10303-21::8.2.2 file_name) is set to the string value submitted through the second method's parameter provided this value is nonnull. If this value is null, then the attribute name is set to the name of this schema instance. The value of the attribute implementation_level of the entity file_description (see ISO 10303-21::8.2.1 file_description) can take one of the following values:

"2;1" if the aggregate associated_models contains at most one model;
"3;1" otherwise; in this case for the schema instance an instance of the entity file_population in the header of the exchange structure (see ISO 10303-21::8.2.4 file_population) is created;

Parameters:: location - the name of the file created by the method.; file_name - the name of the exchange structure to which this schema instance is exported.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.; SdaiException - TR_NEXS, transaction does not exist.; SdaiException - TR_NAVL, transaction currently not available.; SdaiException - FN_NAVL, function not available.; SdaiException - SY_ERR, underlying system error.
Since:: 4.0.0
See Also:: SdaiRepository.exportClearTextEncoding(java.lang.String), exportClearTextEncoding(String location), exportClearTextEncoding(OutputStream location), see "ISO 10303-21"

exportClearTextEncoding

public void exportClearTextEncoding(java.io.OutputStream location)
                             throws SdaiException

Creates a STEP file in a form of the exchange structure containing the data of this schema instance, that is, the header information and all its associated models. At the moment of invocation of the method the repository owning this schema instance must be opened. The exchange structure is written to the supplied stream. The attribute name of the entity file_name in the header of the exchange structure (see ISO 10303-21::8.2.2 file_name) is set to the name of this schema instance. For more details about the exchange format see exportClearTextEncoding(String location). Invoking this method is equivalent to making the following call: exportClearTextEncoding(location, null);

Parameters:: location - an OutputStream the exchange structure is directed to.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.; SdaiException - TR_NEXS, transaction does not exist.; SdaiException - TR_NAVL, transaction currently not available.; SdaiException - FN_NAVL, function not available.; SdaiException - SY_ERR, underlying system error.
Since:: 4.0.0
See Also:: exportClearTextEncoding(String location), exportClearTextEncoding(String location, String file_name), exportClearTextEncoding(OutputStream location, String file_name)

exportClearTextEncoding

public void exportClearTextEncoding(java.io.OutputStream location,
                                    java.lang.String file_name)
                             throws SdaiException

Creates a STEP file in a form of the exchange structure containing the data of this schema instance, that is, the header information and all its associated models. At the moment of invocation of the method the repository owning this schema instance must be opened. The exchange structure is written to the supplied stream. The attribute name of the entity file_name in the header of the exchange structure (see ISO 10303-21::8.2.2 file_name) is set to the string value submitted through the second method's parameter provided this value is nonnull. If this value is null, then the attribute name is set to the name of this schema instance. For more details about the exchange format see exportClearTextEncoding(String location, String file_name).

Parameters:: location - an OutputStream the exchange structure is directed to.; file_name - the name of the exchange structure to which this schema instance is exported.
Throws:: SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - RP_NOPN, repository is not open.; SdaiException - TR_NEXS, transaction does not exist.; SdaiException - TR_NAVL, transaction currently not available.; SdaiException - FN_NAVL, function not available.; SdaiException - SY_ERR, underlying system error.
Since:: 4.0.0
See Also:: exportClearTextEncoding(String location), exportClearTextEncoding(String location, String file_name), exportClearTextEncoding(OutputStream location)

exportXml

public void exportXml(java.io.OutputStream location,
                      InstanceReader instanceReader)
               throws SdaiException

Writes this schema instance in XML representation to specified stream. Output format is controlled by instanceReader parameter.

Parameters:: location - an OutputStream to write XML to; instanceReader - an InstanceReader describing output format
Throws:: SdaiException - if an error occurs during the operation or in underlying JSDAI operations
See Also:: jsdai.xml.InstanceReader, jsdai.xml.LateBindingReader

getIncludedSchemaInstances

public abstract ASchemaInstance getIncludedSchemaInstances()
                                                    throws SdaiException

Returns the set of SchemaInstances included by the current schema instance. The inclusion relation defined on the set of schema instances forms a graph, which must be acyclic.

Returns:: the set of schema instances included by this schema instance.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.
Since:: 4.2.0

addSchemaInstance

public void addSchemaInstance(SchemaInstance schemaInstance)
                       throws SdaiException

Adds a new member to the set of schema instances that are included by this schema instance. If null value is passed to the method's parameter, then SdaiException VA_NSET is thrown. The inclusion relation defined on the set of schema instances forms a graph, which must be acyclic. Therefore, the submitted schema instance is checked against this condition. If inclusion is found to violate this condition, then SdaiException VA_NVLD is thrown. The exception of the same type is also thrown in the case of autoinclusion - when a schema instance is submitted to itself - and also in the case where a schema instance provided as a parameter belongs to "SystemRepository".

Applying inclusion operation to a SchemaInstance in "SystemRepository" is forbidden. In the case of such an attempt, SdaiException VT_NVLD is thrown.

Parameters:: schemaInstance - the SchemaInstance submitted to include into disposition of this schema instance.
Throws:: SdaiException - TR_NEXS, transaction does not exist.; SdaiException - TR_NRW, transaction not read-write.; SdaiException - TR_EAB, transaction ended abnormally.; SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - VT_NVLD, value type invalid.; SdaiException - VA_NVLD, value invalid.; SdaiException - VA_NSET, value not set.; SdaiException - RP_RO, read-only access to repository.; SdaiException - RP_LOCK, repository locked by another user.; SdaiException - SY_ERR, underlying system error.
Since:: 4.2.0

removeSchemaInstance

public void removeSchemaInstance(SchemaInstance schemaInstance)
                          throws SdaiException

Removes a specified member from the set of schema instances that are included by this schema instance. If null value is passed to the method's parameter, then SdaiException VA_NSET is thrown.

Applying removal operation to a SchemaInstance in "SystemRepository" is forbidden. In the case of such an attempt, SdaiException VT_NVLD is thrown.

Parameters:: schemaInstance - the SchemaInstance that is to be removed from the set of included schema instances.
Throws:: SdaiException - TR_NEXS, transaction does not exist.; SdaiException - TR_NRW, transaction not read-write.; SdaiException - TR_EAB, transaction ended abnormally.; SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.; SdaiException - VT_NVLD, value type invalid.; SdaiException - VA_NSET, value not set.; SdaiException - RP_RO, read-only access to repository.; SdaiException - RP_LOCK, repository locked by another user.; SdaiException - SY_ERR, underlying system error.
Since:: 4.2.0

getReferencedModels

public ASdaiModel getReferencedModels()
                               throws SdaiException

Returns the set of SdaiModels associated either with this schema instance or a schema instance reached from this schema instance following the inclusion relation (directly or indirectly). Duplicate appearances of a model are not taken into account.

Returns:: the set of models referenced by this schema instance.
Throws:: SdaiException - RP_NOPN, repository is not open.; SdaiException - SI_NEXS, schema instance does not exist.
Since:: 4.2.0

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jsdai.lang Class SchemaInstance

getName

getDescription

getAuthor

getOrganization

getPreprocessorVersion

setPreprocessorVersion

getOriginatingSystem

setOriginatingSystem

getAuthorization

setAuthorization

getDefaultLanguage

setDefaultLanguage

getContextIdentifiers

checkPermission

checkRead

checkWrite

getAssociatedModels

getNativeSchemaString

getNativeSchema

setNativeSchema

setNativeSchema

getRepository

testChangeDate

getChangeDate

getChangeDateLong

getValidationDate

getValidationDateLong

getValidationResult

getValidationLevel

getDefiningSchema

getLockingUser

delete

rename

addSdaiModel

removeSdaiModel

addSdaiListener

removeSdaiListener

query

getQuerySourceDomain

getQuerySourceInstances

getQuerySourceInstanceRef

getQuerySourceDomainRef

validateGlobalRule

validateGlobalRule

validateUniquenessRule

validateUniquenessRule

validateInstanceReferenceDomain

validateSchemaInstance

isValidationCurrent

toString

exportClearTextEncoding

exportClearTextEncoding

exportClearTextEncoding

exportClearTextEncoding

exportXml

getIncludedSchemaInstances

addSchemaInstance

removeSchemaInstance

getReferencedModels

jsdai.lang
Class SchemaInstance