org.dmd.dmp.shared.generated.dmo.LoginResponseDMO Maven / Gradle / Ivy
Show all versions of dark-matter-data Show documentation
// ---------------------------------------------------------------------------
// dark-matter-data
// Copyright (c) 2010-2021 dark-matter-data committers
// ---------------------------------------------------------------------------
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published by the
// Free Software Foundation; either version 3 of the License, or (at your
// option) any later version.
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
// more details.
// You should have received a copy of the GNU Lesser General Public License along
// with this program; if not, see .
// ---------------------------------------------------------------------------
package org.dmd.dmp.shared.generated.dmo;
// Generated from: org.dmd.dms.util.GenUtility.formatImports(GenUtility.java:408)
import java.io.Serializable; // Always required - (GenUtility.java:227)
import org.dmd.dmc.DmcAttribute; // Any attributes - (GenUtility.java:248)
import org.dmd.dmc.DmcSliceInfo; // Required for object slicing - (GenUtility.java:232)
import org.dmd.dmc.DmcValueException; // Any attributes - (GenUtility.java:249)
import org.dmd.dmp.shared.generated.dmo.ResponseDMO; // Base class - (GenUtility.java:367)
import org.dmd.dms.generated.dmo.MetaDMSAG; // Required for MODREC constructor - (GenUtility.java:231)
import org.dmd.dms.generated.types.DmcTypeIntegerSV; // Required type - (GenUtility.java:339)
import org.dmd.dms.generated.types.DmcTypeModifierMV; // Required for MODREC constructor - (GenUtility.java:230)
import org.dmd.dms.generated.types.DmcTypeStringSV; // Required type - (GenUtility.java:339)
// Generated from: org.dmd.dms.util.DmoFormatter.getClassHeader(DmoFormatter.java:678)
/**
* The LoginResponse is returned after a Login request is received. If the\n
* login is successful, a session ID will be assigned and a request root will
* be given. All\n subsequent requests must contain the session ID and all
* requests will be checked to ensure\n that they pertain to objects at or
* below the request root.\n \n The response may also have an originatorID
* that is a unique identifier assigned by the \n server. In some systems,
* this identifier will be stamped on all incoming requests and\n passed
* through to the events that are generated as a result of those requests. In
* this\n way, a client can tell whether the events it receives came from its
* own requests or from\n requests made by other clients.
*
* Generated from the dmp schema at version 0.1
*
* This code was auto-generated by the dmogenerator utility and shouldn't be alterred manually!
* Generated from: org.dmd.dms.util.DmoFormatter.dumpDMO(DmoFormatter.java:134)
*/
@SuppressWarnings("serial")
public class LoginResponseDMO extends ResponseDMO implements Serializable {
public final static String constructionClassName = "LoginResponse";
static {
}
public LoginResponseDMO() {
super("LoginResponse");
}
protected LoginResponseDMO(String oc) {
super(oc);
}
@Override
public LoginResponseDMO getNew(){
LoginResponseDMO rc = new LoginResponseDMO();
return(rc);
}
@Override
public LoginResponseDMO getSlice(DmcSliceInfo info){
LoginResponseDMO rc = new LoginResponseDMO();
populateSlice(rc,info);
return(rc);
}
public LoginResponseDMO(DmcTypeModifierMV mods) {
super("LoginResponse");
modrec(true);
setModifier(mods);
}
public LoginResponseDMO getModificationRecorder(){
LoginResponseDMO rc = new LoginResponseDMO();
rc.setModifier(new DmcTypeModifierMV(MetaDMSAG.__modify));
rc.modrec(true);
return(rc);
}
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:798)
public String getSessionID(){
DmcTypeStringSV attr = (DmcTypeStringSV) get(DmpDMSAG.__sessionID);
if (attr == null)
return(null);
return(attr.getSV());
}
/**
* Sets sessionID to the specified value.
* @param value String
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:838)
public void setSessionID(String value) {
DmcAttribute attr = get(DmpDMSAG.__sessionID);
if (attr == null)
attr = new DmcTypeStringSV(DmpDMSAG.__sessionID);
try{
attr.set(value);
set(DmpDMSAG.__sessionID,attr);
}
catch(DmcValueException ex){
throw(new IllegalStateException("The type specific set() method shouldn't throw exceptions!",ex));
}
}
/**
* Sets sessionID to the specified value.
* @param value A value compatible with DmcTypeStringSV
* @throws DmcValueException if value is not correct
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:892)
public void setSessionID(Object value) throws DmcValueException {
DmcTypeStringSV attr = (DmcTypeStringSV) get(DmpDMSAG.__sessionID);
if (attr == null)
attr = new DmcTypeStringSV(DmpDMSAG.__sessionID);
attr.set(value);
set(DmpDMSAG.__sessionID,attr);
}
/**
* Removes the sessionID attribute value.
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:912)
public void remSessionID(){
rem(DmpDMSAG.__sessionID);
}
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:798)
public Integer getOriginatorID(){
DmcTypeIntegerSV attr = (DmcTypeIntegerSV) get(DmpDMSAG.__originatorID);
if (attr == null)
return(null);
return(attr.getSV());
}
/**
* Sets originatorID to the specified value.
* @param value Integer
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:838)
public void setOriginatorID(Integer value) {
DmcAttribute attr = get(DmpDMSAG.__originatorID);
if (attr == null)
attr = new DmcTypeIntegerSV(DmpDMSAG.__originatorID);
try{
attr.set(value);
set(DmpDMSAG.__originatorID,attr);
}
catch(DmcValueException ex){
throw(new IllegalStateException("The type specific set() method shouldn't throw exceptions!",ex));
}
}
/**
* Sets originatorID to the specified value.
* @param value A value compatible with DmcTypeIntegerSV
* @throws DmcValueException if value is not correct
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:892)
public void setOriginatorID(Object value) throws DmcValueException {
DmcTypeIntegerSV attr = (DmcTypeIntegerSV) get(DmpDMSAG.__originatorID);
if (attr == null)
attr = new DmcTypeIntegerSV(DmpDMSAG.__originatorID);
attr.set(value);
set(DmpDMSAG.__originatorID,attr);
}
/**
* Removes the originatorID attribute value.
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:912)
public void remOriginatorID(){
rem(DmpDMSAG.__originatorID);
}
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:798)
public String getRequestRoot(){
DmcTypeStringSV attr = (DmcTypeStringSV) get(DmpDMSAG.__requestRoot);
if (attr == null)
return(null);
return(attr.getSV());
}
/**
* Sets requestRoot to the specified value.
* @param value String
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:838)
public void setRequestRoot(String value) {
DmcAttribute attr = get(DmpDMSAG.__requestRoot);
if (attr == null)
attr = new DmcTypeStringSV(DmpDMSAG.__requestRoot);
try{
attr.set(value);
set(DmpDMSAG.__requestRoot,attr);
}
catch(DmcValueException ex){
throw(new IllegalStateException("The type specific set() method shouldn't throw exceptions!",ex));
}
}
/**
* Sets requestRoot to the specified value.
* @param value A value compatible with DmcTypeStringSV
* @throws DmcValueException if value is not correct
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:892)
public void setRequestRoot(Object value) throws DmcValueException {
DmcTypeStringSV attr = (DmcTypeStringSV) get(DmpDMSAG.__requestRoot);
if (attr == null)
attr = new DmcTypeStringSV(DmpDMSAG.__requestRoot);
attr.set(value);
set(DmpDMSAG.__requestRoot,attr);
}
/**
* Removes the requestRoot attribute value.
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:912)
public void remRequestRoot(){
rem(DmpDMSAG.__requestRoot);
}
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:798)
public String getUserFQN(){
DmcTypeStringSV attr = (DmcTypeStringSV) get(DmpDMSAG.__userFQN);
if (attr == null)
return(null);
return(attr.getSV());
}
/**
* Sets userFQN to the specified value.
* @param value String
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:838)
public void setUserFQN(String value) {
DmcAttribute attr = get(DmpDMSAG.__userFQN);
if (attr == null)
attr = new DmcTypeStringSV(DmpDMSAG.__userFQN);
try{
attr.set(value);
set(DmpDMSAG.__userFQN,attr);
}
catch(DmcValueException ex){
throw(new IllegalStateException("The type specific set() method shouldn't throw exceptions!",ex));
}
}
/**
* Sets userFQN to the specified value.
* @param value A value compatible with DmcTypeStringSV
* @throws DmcValueException if value is not correct
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:892)
public void setUserFQN(Object value) throws DmcValueException {
DmcTypeStringSV attr = (DmcTypeStringSV) get(DmpDMSAG.__userFQN);
if (attr == null)
attr = new DmcTypeStringSV(DmpDMSAG.__userFQN);
attr.set(value);
set(DmpDMSAG.__userFQN,attr);
}
/**
* Removes the userFQN attribute value.
*/
// org.dmd.dms.util.GenUtility.formatSV(GenUtility.java:912)
public void remUserFQN(){
rem(DmpDMSAG.__userFQN);
}
}