com.unboundid.scim2.common.ScimResource Maven / Gradle / Ivy
/*
* Copyright 2015-2020 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.scim2.common;
import com.unboundid.scim2.common.types.Meta;
import java.util.Collection;
/**
* Interface that can be used to access data from all SCIM objects.
*/
public interface ScimResource
{
/**
* Gets metadata about the object.
* @return Meta containing metadata about the object.
*/
Meta getMeta();
/**
* Sets metadata for the object.
* @param meta Meta containing metadata for the object.
*/
void setMeta(Meta meta);
/**
* Gets the id of the object.
* @return the id of the object.
*/
String getId();
/**
* Sets the id of the object.
* @param id The object's id.
*/
void setId(String id);
/**
* Gets the objects external id.
* @return The external id of the object.
*/
String getExternalId();
/**
* Sets the object's external id.
* @param externalId The external id of the object.
*/
void setExternalId(String externalId);
/**
* Gets the schema urns for this object. This includes the one for the
* class that extends this class (taken from the annotation), as well as
* any that are present in the extensions.
*
* @return the schema urns for this object.
*/
Collection getSchemaUrns();
/**
* Sets the schema urns for this object. This set should contain
* all schema urns including the one for this object and all
* extensions.
* @param schemaUrns a set containing the schema urns for this object.
*/
void setSchemaUrns(Collection schemaUrns);
/**
* Returns the GenericScimResource representation of this ScimResource. If
* this ScimResource is already a GenericScimResource, this same instance will
* be returned.
*
* @return The GenericScimResource representation of this ScimResource.
*/
GenericScimResource asGenericScimResource();
}