com.legstar.work.manager.WorkItemImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of legstar-distribution
Used to create a single distribution for the entire LegStar project.
The newest version!
/*******************************************************************************
 * Copyright (c) 2010 LegSem.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser Public License v2.1
 * which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * 
 * Contributors:
 *     LegSem - initial API and implementation
 ******************************************************************************/
package com.legstar.work.manager;

import commonj.work.Work;
import commonj.work.WorkException;
import commonj.work.WorkItem;

/**
 * Implements a WorkItem as required by the commonj spec.
 * Original work from Apache Software Foundation.
 */
class WorkItemImpl implements WorkItem {

    /** Identifier if this work item. */
    private String mId;

    /** Completion status. */
    private int mStatus = -1;

    /** the completed Work or null if the Work is not yet complete. */
    private Work mResult;

    /** The work unit from which this item originates. */
    private Work mOriginalWork;

    /** If work unit failed, Exception otherwise null. */
    private WorkException mException;

    /**
     * Creates a work item.
     * 
     * @param id of this work event.
     * @param orginalWork associated work unit
     */
    protected WorkItemImpl(final String id, final Work orginalWork) {
        mId = id;
        mOriginalWork = orginalWork;
        mResult = null;
        mException = null;
    }

    /**
     * Returns the id.
     * 
     * @return Id of this item.
     */
    public String getId() {
        return mId;
    }

    /**
     * Returns the original work.
     * 
     * @return Original work.
     */
    public Work getOriginalWork() {
        return mOriginalWork;
    }

    /**
     * Returns the work result if the work completed.
     * 
     * @return the work result.
     */
    public Work getResult() {
        return mResult;
    }

    /**
     * Sets the result.
     * 
     * @param result Result.
     */
    protected void setResult(final Work result) {
        mResult = result;
    }

    /**
     * Returns the exception if work completed with an exception.
     * 
     * @return Work exception.
     */
    protected WorkException getException() {
        return mException;
    }

    /**
     * Sets the exception.
     * 
     * @param exception Exception.
     */
    protected void setException(final WorkException exception) {
        mException = exception;
    }

    /**
     * Returns the work status (whether the work was accepted, started,
     * rejected or completed).
     * 
     * @return Work status.
     */
    public int getStatus() {
        return mStatus;
    }

    /**
     * Sets the status.
     * 
     * @param status Status.
     */
    protected void setStatus(final int status) {
        mStatus = status;
    }

    /**
     * @see Object#hashCode()
     *      {@inheritDoc}
     */
    public int hashCode() {
        return mId.hashCode();
    }

    /**
     * Indicates whether some other object is "equal to" this one.
     * 
     * @param obj Object to be compared.
     * @return true if this object is the same as the obj argument; false
     *         otherwise..
     */
    public boolean equals(final Object obj) {
        return (obj != null) && (obj.getClass() == WorkItemImpl.class)
                && ((WorkItemImpl) obj).mId.equals(mId);
    }

    /**
     * Compares this object with the specified object for order. Returns a
     * negative integer, zero, or a positive integer as this object is less
     * than, equal to, or greater than the specified object.
     * 
     * @param o Object to be compared.
     * @return A negative integer, zero, or a positive integer as this object
     *         is less than, equal to, or greater than the specified object.
     */
    public int compareTo(final Object o) {
        if (o.getClass() != WorkItemImpl.class) {
            throw new ClassCastException(o.getClass().getName());
        } else {
            return ((WorkItemImpl) o).getId().compareTo(getId());
        }
    }
}