/*
 * Copyright 2010-2012 Luca Garulli (l.garulli(at)orientechnologies.com)
 *
 * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
 *
 * 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 com.orientechnologies.orient.core.db.record.ridbag;

import java.util.Collection;
import java.util.UUID;

import com.orientechnologies.orient.core.db.record.OIdentifiable;
import com.orientechnologies.orient.core.db.record.ORecordLazyMultiValue;
import com.orientechnologies.orient.core.db.record.OTrackedMultiValue;
import com.orientechnologies.orient.core.record.ORecord;

public interface ORidBagDelegate extends Iterable<OIdentifiable>, ORecordLazyMultiValue,
    OTrackedMultiValue<OIdentifiable, OIdentifiable> {
  public void addAll(Collection<OIdentifiable> values);

  public void add(OIdentifiable identifiable);

  public void remove(OIdentifiable identifiable);

  public boolean isEmpty();

  public int getSerializedSize();

  public int getSerializedSize(byte[] stream, int offset);

  /**
   * Writes content of bag to stream.
   * 
   * OwnerUuid is needed to notify db about changes of collection pointer if some happens during serialization.
   * 
   * @param stream
   *          to write content
   * @param offset
   *          in stream where start to write content
   * @param ownerUuid
   *          id of delegate owner
   * @return offset where content of stream is ended
   */
  public int serialize(byte[] stream, int offset, UUID ownerUuid);

  public int deserialize(byte[] stream, int offset);

  public void requestDelete();

  public void setOwner(ORecord<?> owner);

  public ORecord<?> getOwner();

  public String toString();
}
