org.openmdx.security.authentication1.jmi1.Segment Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
//////////////////////////////////////////////////////////////////////////////
//
// Generated by org.openmdx.application.mof.mapping.java.InstanceMapper 2.17.7
// Generated at 2020-11-27T16:04:30.686Z
//
// GENERATED - DO NOT CHANGE MANUALLY
//
//////////////////////////////////////////////////////////////////////////////
package org.openmdx.security.authentication1.jmi1;
/**
* Class Segment
*/
public interface Segment
extends org.openmdx.security.authentication1.cci2.Segment,
org.openmdx.base.jmi1.Segment{
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference authenticationContext 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 getAuthenticationContext(
org.openmdx.security.authentication1.cci2.AuthenticationContextQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference authenticationContext 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.security.authentication1.jmi1.AuthenticationContext getAuthenticationContext(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference authenticationContext for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation getAuthenticationContext(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.security.authentication1.jmi1.AuthenticationContext getAuthenticationContext(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference authenticationContext.
*
* 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 authenticationContext The element to be appended.
*/
public void addAuthenticationContext (
boolean idIsPersistent,
java.lang.String id,
org.openmdx.security.authentication1.jmi1.AuthenticationContext authenticationContext
);
/**
* Adds the specified element to the set of the values for the reference authenticationContext 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 authenticationContext The element to be appended.
*/
public void addAuthenticationContext (
java.lang.String id,
org.openmdx.security.authentication1.jmi1.AuthenticationContext authenticationContext
);
/**
* Adds the specified element to the set of the values for the reference authenticationContext using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param authenticationContext The element to be appended.
*/
public void addAuthenticationContext (
org.openmdx.security.authentication1.jmi1.AuthenticationContext authenticationContext
);
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nWithQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference credential 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 getCredential(
org.openmdx.security.authentication1.cci2.CredentialQuery query
);
// ----------------------------------------------------------------------------
// Instance/IntfReferenceGet0_1WithQualifier
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the reference credential 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.security.authentication1.jmi1.Credential getCredential(
boolean idIsPersistent,
java.lang.String id
);
/**
* Retrieves the value for the reference credential for the specified qualifier attribute value.
*
* This method is equivalent to the preferred invocation getCredential(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.security.authentication1.jmi1.Credential getCredential(
java.lang.String id
);
// ----------------------------------------------------------------------------
// Instance/ReferenceAddWithQualifier
// ----------------------------------------------------------------------------
/**
* Adds the specified element to the set of the values for the reference credential.
*
* 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 credential The element to be appended.
*/
public void addCredential (
boolean idIsPersistent,
java.lang.String id,
org.openmdx.security.authentication1.jmi1.Credential credential
);
/**
* Adds the specified element to the set of the values for the reference credential 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 credential The element to be appended.
*/
public void addCredential (
java.lang.String id,
org.openmdx.security.authentication1.jmi1.Credential credential
);
/**
* Adds the specified element to the set of the values for the reference credential using an implementation-specific, reassignable qualifier.
*
* Note: This is an extension to the JMI 1 standard.
* @param credential The element to be appended.
*/
public void addCredential (
org.openmdx.security.authentication1.jmi1.Credential credential
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
}