org.openmdx.preferences2.cci2.Node Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
//////////////////////////////////////////////////////////////////////////////
//
// Name: $Id: AbstractMapper.java,v 1.10 2011/07/08 13:20:51 wfro Exp $
// Generated by: openMDX Java Mapper
// Date: Mon Mar 09 17:04:35 CET 2020
//
// GENERATED - DO NOT CHANGE MANUALLY
//
//////////////////////////////////////////////////////////////////////////////
package org.openmdx.preferences2.cci2;
/**
* Class Node
*
* A node in a hierarchical collection of preference data. This class allows applications to store and retrieve user and system preference and configuration data.
* This data is stored persistently in an implementation-dependent backing store.
* Typical implementations include flat files, OS-specific registries, directory servers and SQL databases.
* The user of this class needn't be concerned with details of the backing store.
* Nodes in a preference tree are named in a similar fashion to directories in a hierarchical file system.
* Every node in a preference tree has a node name (which is not necessarily unique), a unique absolute path name, and a path name relative to each ancestor including itself.
*/
public interface Node
extends org.openmdx.base.cci2.BasicObject{
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute absolutePath.
*
* The root node has an absolute path name of "/".
* Children of the root node have absolute path names of "/" + .
* All other nodes have absolute path names of + "/" + .
* Note that all absolute path names begin with the slash character.
* @return The non-null value for attribute absolutePath.
*/
public java.lang.String getAbsolutePath(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the members of the given container referencing this object via child.
*
* Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with javax.jdo.Query
* @param nodeContainer The container of the objects to be retrieved.
* @return The members referencing ths object via child.
*/
public java.util.Collection getChild(
org.openmdx.preferences2.cci2.Root nodeContainer
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves a set containing all the elements for the reference entry.
* @return A set containing all the elements for this reference.
*/
public org.openmdx.preferences2.cci2.NodeHasEntries.Entry getEntry(
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute name.
*
* The root node has a node name of the empty string ("").
* Every other node has an arbitrary node name, specified at the time it is created.
* The only restrictions on this name are that it cannot be the empty string, and it cannot contain the slash character ('/').
* @return The non-null value for attribute name.
*/
public java.lang.String getName(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute name.
*
* This attribute is not changeable, i.e. its value can be set as long as the object is TRANSIENT or NEW
*
* The root node has a node name of the empty string ("").
* Every other node has an arbitrary node name, specified at the time it is created.
* The only restrictions on this name are that it cannot be the empty string, and it cannot contain the slash character ('/').
* @param name The non-null new value for attribute name.
*/
public void setName(
java.lang.String name
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference parent.
* @return The – possibly null – value for this reference.
*/
public org.openmdx.preferences2.cci2.Node getParent(
);
// ----------------------------------------------------------------------------
// Instance/ReferenceSetNoQualifier
// ----------------------------------------------------------------------------
/**
* Sets a new value for the reference parent.
* @param parent The new – possibly null – value for this reference.
*/
public void setParent(
org.openmdx.preferences2.cci2.Node parent
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference root.
* @return The non-null value for this reference.
*/
public org.openmdx.preferences2.cci2.Root getRoot(
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// Instance/Containment
// ----------------------------------------------------------------------------
/**
* Object Identity
*/
public interface Identity extends org.oasisopen.cci2.Identity {
/**
* Retrieve the Root's identity
* @return the parent object's identity
*/
public org.oasisopen.cci2.Identity getRoot();
/**
* Tells whether the id value is persistent or reassignable.
* @return PERSISTENT or REASSIGNABLE
*/
public org.oasisopen.cci2.QualifierType getIdType();
/**
* The id value
* @return the id value
*/
public java.lang.String getId();
}
}