Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Copyright 2005-2012 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.opensource.org/licenses/ecl2.php Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 
 package org.kuali.rice.kim.impl.identity;
 
This service archives EntityDefault. It's purpose is to provide long term storage for basic identity data that may be removed from the IdentityService implementation's backing store.

Author(s):
Kuali Rice Team (rice.collab@kuali.org)
 
 public interface IdentityArchiveService {

    
Gets a org.kuali.rice.kim.api.identity.entity.EntityDefault with an id from the archive. org.kuali.rice.kim.api.identity.entity.EntityDefault is a condensed version of org.kuali.rice.kim.api.identity.entity.Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Parameters:
id the unique id to retrieve the entity by. cannot be null.
Returns:
a org.kuali.rice.kim.api.identity.entity.EntityDefault or null
Throws:
java.lang.IllegalArgumentException if the id is blank
 
Gets a org.kuali.rice.kim.api.identity.entity.EntityDefault with an principalId from the archive. org.kuali.rice.kim.api.identity.entity.EntityDefault is a condensed version of org.kuali.rice.kim.api.identity.entity.Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Parameters:
principalId the unique principalId to retrieve the entity by. cannot be null.
Returns:
a org.kuali.rice.kim.api.identity.entity.EntityDefault or null
Throws:
java.lang.IllegalArgumentException if the principalId is blank
 
Gets a org.kuali.rice.kim.api.identity.entity.EntityDefault with an principalName from the archive. org.kuali.rice.kim.api.identity.entity.EntityDefault is a condensed version of org.kuali.rice.kim.api.identity.entity.Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Parameters:
principalName the unique principalName to retrieve the entity by. cannot be null.
Returns:
a org.kuali.rice.kim.api.identity.entity.EntityDefault or null
Throws:
java.lang.IllegalArgumentException if the principalName is blank
 
Gets a org.kuali.rice.kim.api.identity.entity.EntityDefault with an employeeId from the archive. org.kuali.rice.kim.api.identity.entity.EntityDefault is a condensed version of org.kuali.rice.kim.api.identity.entity.Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Parameters:
employeeId the unique employeeId to retrieve the entity by. cannot be null.
Returns:
a org.kuali.rice.kim.api.identity.entity.EntityDefault or null
Throws:
java.lang.IllegalArgumentException if the employeeId is blank
 
Saves a org.kuali.rice.kim.api.identity.entity.EntityDefault to the archive. org.kuali.rice.kim.api.identity.entity.EntityDefault is a condensed version of org.kuali.rice.kim.api.identity.entity.Entity that contains default values of its subclasses

This method will return the saved EntityDefault object

Parameters:
entityDefault the unique principalName to retrieve the entity by. cannot be null.
Returns:
a org.kuali.rice.kim.api.identity.entity.EntityDefault or null
Throws:
java.lang.IllegalArgumentException if the entityDefault is null
    //TODO: this should probably return some kind of Future<EntityDefault> if we can find a way to remote that
Flushes org.kuali.rice.kim.api.identity.entity.EntityDefault to the archive.

This method flushes the "saved" entities to the database

Returns:
void
New to GrepCode? Check out our FAQ X