com.helger.regrep.spi.CatalogObjectsRequest Maven / Gradle / Ivy
Show all versions of ph-regrep Show documentation
package com.helger.regrep.spi;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import com.helger.commons.annotation.CodingStyleguideUnaware;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.annotation.ReturnsMutableObject;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.ToStringGenerator;
import com.helger.regrep.rim.ExtrinsicObjectType;
import com.helger.regrep.rim.ObjectRefListType;
import com.helger.regrep.rim.QueryType;
import com.helger.regrep.rim.RegistryObjectListType;
import com.helger.regrep.rs.RegistryRequestType;
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <extension base="{urn:oasis:names:tc:ebxml-regrep:xsd:rs:4.0}RegistryRequestType">
* <sequence>
* <element name="Query" type="{urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0}QueryType" minOccurs="0"/>
* <element ref="{urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0}ObjectRefList" minOccurs="0"/>
* <element name="OriginalObjects" type="{urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0}RegistryObjectListType" minOccurs="0"/>
* <element name="InvocationControlFile" type="{urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0}ExtrinsicObjectType" maxOccurs="unbounded" minOccurs="0"/>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
* This class was annotated by ph-jaxb22-plugin -Xph-annotate
* This class contains methods created by ph-jaxb22-plugin -Xph-equalshashcode
* This class contains methods created by ph-jaxb22-plugin -Xph-tostring
* This class contains methods created by ph-jaxb22-plugin -Xph-list-extension
* This class contains methods created by ph-jaxb22-plugin -Xph-cloneable2
* This class contains methods created by ph-jaxb22-plugin -Xph-value-extender
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
"query",
"objectRefList",
"originalObjects",
"invocationControlFile"
})
@XmlRootElement(name = "CatalogObjectsRequest")
@CodingStyleguideUnaware
public class CatalogObjectsRequest
extends RegistryRequestType
{
@XmlElement(name = "Query")
private QueryType query;
@XmlElement(name = "ObjectRefList", namespace = "urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0")
private ObjectRefListType objectRefList;
@XmlElement(name = "OriginalObjects")
private RegistryObjectListType originalObjects;
@XmlElement(name = "InvocationControlFile")
private List invocationControlFile;
/**
* Default constructor
* Note: automatically created by ph-jaxb22-plugin -Xph-value-extender
*
*/
public CatalogObjectsRequest() {
}
/**
* Gets the value of the query property.
*
* @return
* possible object is
* {@link QueryType }
*
*/
@Nullable
public QueryType getQuery() {
return query;
}
/**
* Sets the value of the query property.
*
* @param value
* allowed object is
* {@link QueryType }
*
*/
public void setQuery(
@Nullable
QueryType value) {
this.query = value;
}
/**
* Gets the value of the objectRefList property.
*
* @return
* possible object is
* {@link ObjectRefListType }
*
*/
@Nullable
public ObjectRefListType getObjectRefList() {
return objectRefList;
}
/**
* Sets the value of the objectRefList property.
*
* @param value
* allowed object is
* {@link ObjectRefListType }
*
*/
public void setObjectRefList(
@Nullable
ObjectRefListType value) {
this.objectRefList = value;
}
/**
* Gets the value of the originalObjects property.
*
* @return
* possible object is
* {@link RegistryObjectListType }
*
*/
@Nullable
public RegistryObjectListType getOriginalObjects() {
return originalObjects;
}
/**
* Sets the value of the originalObjects property.
*
* @param value
* allowed object is
* {@link RegistryObjectListType }
*
*/
public void setOriginalObjects(
@Nullable
RegistryObjectListType value) {
this.originalObjects = value;
}
/**
* Gets the value of the invocationControlFile property.
*
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a set method for the invocationControlFile property.
*
*
* For example, to add a new item, do as follows:
*
* getInvocationControlFile().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link ExtrinsicObjectType }
*
*
*/
@Nonnull
@ReturnsMutableObject("JAXB implementation style")
public List getInvocationControlFile() {
if (invocationControlFile == null) {
invocationControlFile = new ArrayList();
}
return this.invocationControlFile;
}
/**
* Created by ph-jaxb22-plugin -Xph-equalshashcode
*
*/
@Override
public boolean equals(final Object o) {
if (o == this) {
return true;
}
if (!super.equals(o)) {
return false;
}
final CatalogObjectsRequest rhs = ((CatalogObjectsRequest) o);
if (!EqualsHelper.equalsCollection(invocationControlFile, rhs.invocationControlFile)) {
return false;
}
if (!EqualsHelper.equals(objectRefList, rhs.objectRefList)) {
return false;
}
if (!EqualsHelper.equals(originalObjects, rhs.originalObjects)) {
return false;
}
if (!EqualsHelper.equals(query, rhs.query)) {
return false;
}
return true;
}
/**
* Created by ph-jaxb22-plugin -Xph-equalshashcode
*
*/
@Override
public int hashCode() {
return HashCodeGenerator.getDerived(super.hashCode()).append(invocationControlFile).append(objectRefList).append(originalObjects).append(query).getHashCode();
}
/**
* Created by ph-jaxb22-plugin -Xph-tostring
*
*/
@Override
public String toString() {
return ToStringGenerator.getDerived(super.toString()).append("invocationControlFile", invocationControlFile).append("objectRefList", objectRefList).append("originalObjects", originalObjects).append("query", query).getToString();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param aList
* The new list member to set. May be null.
*/
public void setInvocationControlFile(
@Nullable
final List aList) {
invocationControlFile = aList;
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if at least one item is contained, false otherwise.
*/
public boolean hasInvocationControlFileEntries() {
return (!getInvocationControlFile().isEmpty());
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* true if no item is contained, false otherwise.
*/
public boolean hasNoInvocationControlFileEntries() {
return getInvocationControlFile().isEmpty();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @return
* The number of contained elements. Always ≥ 0.
*/
@Nonnegative
public int getInvocationControlFileCount() {
return getInvocationControlFile().size();
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param index
* The index to retrieve
* @return
* The element at the specified index. May be null
* @throws IndexOutOfBoundsException
* if the index is invalid!
*/
@Nullable
public ExtrinsicObjectType getInvocationControlFileAtIndex(
@Nonnegative
final int index)
throws IndexOutOfBoundsException
{
return getInvocationControlFile().get(index);
}
/**
* Created by ph-jaxb22-plugin -Xph-list-extension
*
* @param elem
* The element to be added. May not be null.
*/
public void addInvocationControlFile(
@Nonnull
final ExtrinsicObjectType elem) {
getInvocationControlFile().add(elem);
}
/**
* This method clones all values from this to the passed object. All data in the parameter object is overwritten!Created by ph-jaxb22-plugin -Xph-cloneable2
*
* @param ret
* The target object to clone to. May not be null.
*/
public void cloneTo(
@Nonnull
CatalogObjectsRequest ret) {
super.cloneTo(ret);
if (invocationControlFile == null) {
ret.invocationControlFile = null;
} else {
List retInvocationControlFile = new ArrayList();
for (ExtrinsicObjectType aItem: getInvocationControlFile()) {
retInvocationControlFile.add(((aItem == null)?null:aItem.clone()));
}
ret.invocationControlFile = retInvocationControlFile;
}
ret.objectRefList = ((objectRefList == null)?null:objectRefList.clone());
ret.originalObjects = ((originalObjects == null)?null:originalObjects.clone());
ret.query = ((query == null)?null:query.clone());
}
/**
* Created by ph-jaxb22-plugin -Xph-cloneable2
*
* @return
* The cloned object. Never null.
*/
@Nonnull
@ReturnsMutableCopy
@Override
public CatalogObjectsRequest clone() {
CatalogObjectsRequest ret = new CatalogObjectsRequest();
cloneTo(ret);
return ret;
}
}