org.openmdx.preferences2.jmi1.Node Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
//////////////////////////////////////////////////////////////////////////////
//
// Generated by org.openmdx.application.mof.mapping.java.InstanceMapper 2.17.7
// Generated at 2020-11-27T16:04:08.572Z
//
// GENERATED - DO NOT CHANGE MANUALLY
//
//////////////////////////////////////////////////////////////////////////////
package org.openmdx.preferences2.jmi1;
/**
* 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.preferences2.cci2.Node,
org.openmdx.base.jmi1.BasicObject{
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference entry for the specified query.
* 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 query predicate which is applied to the set of referenced objects.
* @return The objects for which the predicate evaluates to true.
*/
public java.util.List getEntry(
org.openmdx.preferences2.cci2.EntryQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference entry for the specified qualifier attribute value.
*
* @param idIsPersistent Defines whether value for the qualifier is persistent or not
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.openmdx.preferences2.jmi1.Entry getEntry(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference entry for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation getEntry(false,id).
*
* @param id The value for the qualifier attribute that qualifies this reference.
* @return The possibly null value for this qualifier
*/
public org.openmdx.preferences2.jmi1.Entry getEntry(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference entry.
*
* Note: This is an extension to the JMI 1 standard.
* @param idIsPersistent true if id is persistent
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param entry The element to be appended.
*/
public void addEntry (
boolean idIsPersistent,
java.lang.String id,
org.openmdx.preferences2.jmi1.Entry entry
);
/**
* Adds the specified element to the set of the values for the reference entry using a reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param id The qualifier attribute value that qualifies the reference to get the element to be appended.
* @param entry The element to be appended.
*/
public void addEntry (
java.lang.String id,
org.openmdx.preferences2.jmi1.Entry entry
);
/**
* Adds the specified element to the set of the values for the reference entry using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param entry The element to be appended.
*/
public void addEntry (
org.openmdx.preferences2.jmi1.Entry entry
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGetx_1NoQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference parent.
* @return The – possibly null – value for this reference.
*/
public org.openmdx.preferences2.jmi1.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.jmi1.Root getRoot(
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
// Instance/Containment
// ----------------------------------------------------------------------------
}