/**
    * 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.kew.rule;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import org.kuali.rice.kew.api.identity.Id;
  import org.kuali.rice.kew.api.identity.PrincipalId;
  import org.kuali.rice.kew.api.rule.RoleName;
  
  /**
   * A generic Role Attribute that can be used to route to a Principal ID. Can
   * take as configuration the label to use for the element name in the XML. This
   * allows for re-use of this component in different contexts.
   * 
   * @author Kuali Rice Team (rice.collab@kuali.org)
   */
  public class PrincipalIdRoleAttribute extends AbstractIdRoleAttribute {
  
  	private static final long serialVersionUID = 8784036641718163820L;
  
  	private static final String PRINCIPAL_ID_ROLE_NAME = "principalId";
  	private static final String ATTRIBUTE_ELEMENT = "PrincipalIdRoleAttribute";
  	private static final String PRINCIPAL_ID_ELEMENT = "principalId";
  
  	public List<RoleName> getRoleNames() {
  		List<RoleName> roleNames = new ArrayList<RoleName>();
  		roleNames.add(new RoleName(getClass().getName(), PRINCIPAL_ID_ROLE_NAME, "Principal ID"));
  		return roleNames;
  	}
  
  	protected String getAttributeElementName() {
  		return ATTRIBUTE_ELEMENT;
  	}
  
  	protected Id resolveId(String id) {
  		return id == null ? null : new PrincipalId(id);
  	}
  
  	protected String getIdName() {
  		return PRINCIPAL_ID_ELEMENT;
  	}
  
  	public String getPrincipalId() {
  		return getIdValue();
  	}
  
  	public void setPrincipalId(String principalId) {
  		setIdValue(principalId);
  	}
  
  }